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

Namespaces

  • Aws
    • AccessAnalyzer
      • Exception
    • Account
      • Exception
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • AmplifyBackend
      • Exception
    • AmplifyUIBuilder
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • AppConfigData
      • Exception
    • Appflow
      • Exception
    • AppIntegrationsService
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationCostProfiler
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • AppRegistry
      • Exception
    • AppRunner
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • ARCZonalShift
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • BackupGateway
      • Exception
    • BackupStorage
      • Exception
    • Batch
      • Exception
    • BillingConductor
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ChimeSDKIdentity
      • Exception
    • ChimeSDKMediaPipelines
      • Exception
    • ChimeSDKMeetings
      • Exception
    • ChimeSDKMessaging
      • Exception
    • ChimeSDKVoice
      • Exception
    • CleanRooms
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudControlApi
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudTrailData
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchEvidently
      • Exception
    • CloudWatchLogs
      • Exception
    • CloudWatchRUM
      • Exception
    • CodeArtifact
      • Exception
    • CodeBuild
      • Exception
    • CodeCatalyst
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodeGuruProfiler
      • Exception
    • CodeGuruReviewer
      • Exception
    • CodePipeline
      • Exception
    • CodeStar
      • Exception
    • CodeStarconnections
      • Exception
    • CodeStarNotifications
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoIdentityProvider
      • Exception
    • CognitoSync
      • Exception
    • Comprehend
      • Exception
    • ComprehendMedical
      • Exception
    • ComputeOptimizer
      • Exception
    • ConfigService
      • Exception
    • Connect
      • Exception
    • ConnectCampaignService
      • Exception
    • ConnectCases
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • ConnectWisdomService
      • Exception
    • ControlTower
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
      • Polyfill
    • CustomerProfiles
      • Exception
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • DefaultsMode
      • Exception
    • Detective
      • Exception
    • DeviceFarm
      • Exception
    • DevOpsGuru
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • Exception
    • DocDBElastic
      • Exception
    • drs
      • Exception
    • DynamoDb
      • Exception
    • DynamoDbStreams
      • Exception
    • EBS
      • Exception
    • Ec2
      • Exception
    • EC2InstanceConnect
      • Exception
    • Ecr
      • Exception
    • ECRPublic
      • Exception
    • Ecs
      • Exception
    • Efs
      • Exception
    • EKS
      • Exception
    • ElastiCache
      • Exception
    • ElasticBeanstalk
      • Exception
    • ElasticInference
      • Exception
    • ElasticLoadBalancing
      • Exception
    • ElasticLoadBalancingV2
      • Exception
    • ElasticsearchService
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Exception
    • EMRContainers
      • Exception
    • EMRServerless
      • Exception
    • Endpoint
      • UseDualstackEndpoint
        • Exception
      • UseFipsEndpoint
        • Exception
    • EndpointDiscovery
      • Exception
    • EndpointV2
      • Rule
      • Ruleset
    • EventBridge
      • Exception
    • Exception
    • finspace
      • Exception
    • FinSpaceData
      • Exception
    • Firehose
      • Exception
    • FIS
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • Exception
    • GameSparks
      • Exception
    • Glacier
      • Exception
    • GlobalAccelerator
      • Exception
    • Glue
      • Exception
    • GlueDataBrew
      • Exception
    • Greengrass
      • Exception
    • GreengrassV2
      • Exception
    • GroundStation
      • Exception
    • GuardDuty
      • Exception
    • Handler
      • GuzzleV5
      • GuzzleV6
    • Health
      • Exception
    • HealthLake
      • Exception
    • Honeycode
      • Exception
    • Iam
      • Exception
    • IdentityStore
      • Exception
    • imagebuilder
      • Exception
    • ImportExport
      • Exception
    • Inspector
      • Exception
    • Inspector2
      • Exception
    • InternetMonitor
      • Exception
    • Iot
      • Exception
    • IoT1ClickDevicesService
      • Exception
    • IoT1ClickProjects
      • Exception
    • IoTAnalytics
      • Exception
    • IotDataPlane
      • Exception
    • IoTDeviceAdvisor
      • Exception
    • IoTEvents
      • Exception
    • IoTEventsData
      • Exception
    • IoTFleetHub
      • Exception
    • IoTFleetWise
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTRoboRunner
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTTwinMaker
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • ivschat
      • Exception
    • IVSRealTime
      • Exception
    • Kafka
      • Exception
    • KafkaConnect
      • Exception
    • kendra
      • Exception
    • KendraRanking
      • Exception
    • Keyspaces
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • KinesisVideoWebRTCStorage
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexModelsV2
      • Exception
    • LexRuntimeService
      • Exception
    • LexRuntimeV2
      • Exception
    • LicenseManager
      • Exception
    • LicenseManagerLinuxSubscriptions
      • Exception
    • LicenseManagerUserSubscriptions
      • Exception
    • Lightsail
      • Exception
    • LocationService
      • Exception
    • LookoutEquipment
      • Exception
    • LookoutforVision
      • Exception
    • LookoutMetrics
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • Macie2
      • Exception
    • MainframeModernization
      • Exception
    • ManagedBlockchain
      • Exception
    • ManagedGrafana
      • Exception
    • MarketplaceCatalog
      • Exception
    • MarketplaceCommerceAnalytics
      • Exception
    • MarketplaceEntitlementService
      • Exception
    • MarketplaceMetering
      • Exception
    • MediaConnect
      • Exception
    • MediaConvert
      • Exception
    • MediaLive
      • Exception
    • MediaPackage
      • Exception
    • MediaPackageVod
      • Exception
    • MediaStore
      • Exception
    • MediaStoreData
      • Exception
    • MediaTailor
      • Exception
    • MemoryDB
      • Exception
    • mgn
      • Exception
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • MigrationHubOrchestrator
      • Exception
    • MigrationHubRefactorSpaces
      • Exception
    • MigrationHubStrategyRecommendations
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • NimbleStudio
      • Exception
    • OAM
      • Exception
    • Omics
      • Exception
    • OpenSearchServerless
      • Exception
    • OpenSearchService
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Outposts
      • Exception
    • Panorama
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • PinpointSMSVoiceV2
      • Exception
    • Pipes
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrivateNetworks
      • Exception
    • PrometheusService
      • Exception
    • Proton
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • RecycleBin
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • RedshiftServerless
      • Exception
    • Rekognition
      • Exception
    • ResilienceHub
      • Exception
    • ResourceExplorer2
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • Exception
    • RolesAnywhere
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • Exception
    • Route53RecoveryCluster
      • Exception
    • Route53RecoveryControlConfig
      • Exception
    • Route53RecoveryReadiness
      • Exception
    • Route53Resolver
      • Exception
    • S3
      • Crypto
      • Exception
      • RegionalEndpoint
        • Exception
      • UseArnRegion
        • Exception
    • S3Control
      • Exception
    • S3Outposts
      • Exception
    • SageMaker
      • Exception
    • SagemakerEdgeManager
      • Exception
    • SageMakerFeatureStoreRuntime
      • Exception
    • SageMakerGeospatial
      • Exception
    • SageMakerMetrics
      • Exception
    • SageMakerRuntime
      • Exception
    • SavingsPlans
      • Exception
    • Scheduler
      • Exception
    • Schemas
      • Exception
    • Script
      • Composer
    • SecretsManager
      • Exception
    • SecurityHub
      • Exception
    • SecurityLake
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • ServiceQuotas
      • Exception
    • Ses
      • Exception
    • SesV2
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • signer
      • Exception
    • SimSpaceWeaver
      • Exception
    • Sms
      • Exception
    • SnowBall
      • Exception
    • SnowDeviceManagement
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSMContacts
      • Exception
    • SSMIncidents
      • Exception
    • SsmSap
      • Exception
    • SSO
      • Exception
    • SSOAdmin
      • Exception
    • SSOOIDC
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
      • RegionalEndpoints
        • Exception
    • Support
      • Exception
    • SupportApp
      • Exception
    • Swf
      • Exception
    • Synthetics
      • Exception
    • Textract
      • Exception
    • TimestreamQuery
      • Exception
    • TimestreamWrite
      • Exception
    • Tnb
      • Exception
    • Token
    • TranscribeService
      • Exception
    • Transfer
      • Exception
    • Translate
      • Exception
    • VoiceID
      • Exception
    • VPCLattice
      • 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\ARCZonalShift\ARCZonalShiftClient
  • Aws\Athena\AthenaClient
  • Aws\AuditManager\AuditManagerClient
  • Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Backup\BackupClient
  • Aws\BackupGateway\BackupGatewayClient
  • Aws\BackupStorage\BackupStorageClient
  • 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\ChimeSDKVoice\ChimeSDKVoiceClient
  • Aws\CleanRooms\CleanRoomsClient
  • 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\CloudTrailData\CloudTrailDataClient
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchEvidently\CloudWatchEvidentlyClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CloudWatchRUM\CloudWatchRUMClient
  • Aws\CodeArtifact\CodeArtifactClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCatalyst\CodeCatalystClient
  • 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\ConnectCases\ConnectCasesClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\ConnectWisdomService\ConnectWisdomServiceClient
  • Aws\ControlTower\ControlTowerClient
  • 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\DocDBElastic\DocDBElasticClient
  • 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\EndpointV2\EndpointDefinitionProvider
  • Aws\EndpointV2\EndpointProviderV2
  • Aws\EndpointV2\Rule\AbstractRule
  • Aws\EndpointV2\Rule\EndpointRule
  • Aws\EndpointV2\Rule\ErrorRule
  • Aws\EndpointV2\Rule\RuleCreator
  • Aws\EndpointV2\Rule\TreeRule
  • Aws\EndpointV2\Ruleset\Ruleset
  • Aws\EndpointV2\Ruleset\RulesetEndpoint
  • Aws\EndpointV2\Ruleset\RulesetParameter
  • 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\InternetMonitor\InternetMonitorClient
  • 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\IoTFleetWise\IoTFleetWiseClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTRoboRunner\IoTRoboRunnerClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTSiteWise\IoTSiteWiseClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\IoTTwinMaker\IoTTwinMakerClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\ivschat\ivschatClient
  • Aws\IVSRealTime\IVSRealTimeClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\KafkaConnect\KafkaConnectClient
  • Aws\kendra\kendraClient
  • Aws\KendraRanking\KendraRankingClient
  • 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\KinesisVideoWebRTCStorage\KinesisVideoWebRTCStorageClient
  • 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\LicenseManagerLinuxSubscriptions\LicenseManagerLinuxSubscriptionsClient
  • Aws\LicenseManagerUserSubscriptions\LicenseManagerUserSubscriptionsClient
  • 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\MigrationHubOrchestrator\MigrationHubOrchestratorClient
  • 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\OAM\OAMClient
  • Aws\Omics\OmicsClient
  • Aws\OpenSearchServerless\OpenSearchServerlessClient
  • 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\Pipes\PipesClient
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrivateNetworks\PrivateNetworksClient
  • 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\RedshiftServerless\RedshiftServerlessClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResilienceHub\ResilienceHubClient
  • Aws\ResourceExplorer2\ResourceExplorer2Client
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\Retry\Configuration
  • Aws\Retry\ConfigurationProvider
  • Aws\RoboMaker\RoboMakerClient
  • Aws\RolesAnywhere\RolesAnywhereClient
  • 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\SageMakerGeospatial\SageMakerGeospatialClient
  • Aws\SageMakerMetrics\SageMakerMetricsClient
  • Aws\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\SavingsPlans\SavingsPlansClient
  • Aws\Scheduler\SchedulerClient
  • Aws\Schemas\SchemasClient
  • Aws\Script\Composer\Composer
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\SecurityHub\SecurityHubClient
  • Aws\SecurityLake\SecurityLakeClient
  • 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\SimSpaceWeaver\SimSpaceWeaverClient
  • 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\SsmSap\SsmSapClient
  • 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\SupportApp\SupportAppClient
  • Aws\Swf\SwfClient
  • Aws\Synthetics\SyntheticsClient
  • Aws\Textract\TextractClient
  • Aws\TimestreamQuery\TimestreamQueryClient
  • Aws\TimestreamWrite\TimestreamWriteClient
  • Aws\Tnb\TnbClient
  • Aws\Token\BearerTokenAuthorization
  • Aws\Token\SsoToken
  • Aws\Token\SsoTokenProvider
  • Aws\Token\Token
  • Aws\Token\TokenProvider
  • Aws\TraceMiddleware
  • Aws\TranscribeService\TranscribeServiceClient
  • Aws\Transfer\TransferClient
  • Aws\Translate\TranslateClient
  • Aws\VoiceID\VoiceIDClient
  • Aws\VPCLattice\VPCLatticeClient
  • 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
  • Aws\Token\RefreshableTokenProviderInterface
  • Aws\Token\TokenAuthorization
  • Aws\Token\TokenInterface

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
  • Aws\Token\ParsesIniTrait

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\ARCZonalShift\Exception\ARCZonalShiftException
  • 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\BackupStorage\Exception\BackupStorageException
  • 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\ChimeSDKVoice\Exception\ChimeSDKVoiceException
  • Aws\CleanRooms\Exception\CleanRoomsException
  • 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\CloudTrailData\Exception\CloudTrailDataException
  • 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\CodeCatalyst\Exception\CodeCatalystException
  • 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\ConnectCases\Exception\ConnectCasesException
  • Aws\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\ConnectWisdomService\Exception\ConnectWisdomServiceException
  • Aws\ControlTower\Exception\ControlTowerException
  • 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\DocDBElastic\Exception\DocDBElasticException
  • 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\TokenException
  • 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\InternetMonitor\Exception\InternetMonitorException
  • 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\IoTFleetWise\Exception\IoTFleetWiseException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTRoboRunner\Exception\IoTRoboRunnerException
  • 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\IVSRealTime\Exception\IVSRealTimeException
  • Aws\Kafka\Exception\KafkaException
  • Aws\KafkaConnect\Exception\KafkaConnectException
  • Aws\kendra\Exception\kendraException
  • Aws\KendraRanking\Exception\KendraRankingException
  • 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\KinesisVideoWebRTCStorage\Exception\KinesisVideoWebRTCStorageException
  • 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\LicenseManagerLinuxSubscriptions\Exception\LicenseManagerLinuxSubscriptionsException
  • Aws\LicenseManagerUserSubscriptions\Exception\LicenseManagerUserSubscriptionsException
  • 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\MigrationHubOrchestrator\Exception\MigrationHubOrchestratorException
  • 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\OAM\Exception\OAMException
  • Aws\Omics\Exception\OmicsException
  • Aws\OpenSearchServerless\Exception\OpenSearchServerlessException
  • 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\Pipes\Exception\PipesException
  • Aws\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\PrivateNetworks\Exception\PrivateNetworksException
  • 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\RedshiftServerless\Exception\RedshiftServerlessException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResilienceHub\Exception\ResilienceHubException
  • Aws\ResourceExplorer2\Exception\ResourceExplorer2Exception
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\Retry\Exception\ConfigurationException
  • Aws\RoboMaker\Exception\RoboMakerException
  • Aws\RolesAnywhere\Exception\RolesAnywhereException
  • 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\SageMakerGeospatial\Exception\SageMakerGeospatialException
  • Aws\SageMakerMetrics\Exception\SageMakerMetricsException
  • Aws\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SavingsPlans\Exception\SavingsPlansException
  • Aws\Scheduler\Exception\SchedulerException
  • Aws\Schemas\Exception\SchemasException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\SecurityHub\Exception\SecurityHubException
  • Aws\SecurityLake\Exception\SecurityLakeException
  • 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\SimSpaceWeaver\Exception\SimSpaceWeaverException
  • 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\SsmSap\Exception\SsmSapException
  • 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\SupportApp\Exception\SupportAppException
  • Aws\Swf\Exception\SwfException
  • Aws\Synthetics\Exception\SyntheticsException
  • Aws\Textract\Exception\TextractException
  • Aws\TimestreamQuery\Exception\TimestreamQueryException
  • Aws\TimestreamWrite\Exception\TimestreamWriteException
  • Aws\Tnb\Exception\TnbException
  • Aws\TranscribeService\Exception\TranscribeServiceException
  • Aws\Transfer\Exception\TransferException
  • Aws\Translate\Exception\TranslateException
  • Aws\VoiceID\Exception\VoiceIDException
  • Aws\VPCLattice\Exception\VPCLatticeException
  • 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

AWS License Manager 2018-08-01

Client: Aws\LicenseManager\LicenseManagerClient
Service ID: license-manager
Version: 2018-08-01

This page describes the parameters and results for the operations of the AWS License Manager (2018-08-01), and shows how to use the Aws\LicenseManager\LicenseManagerClient object to call the described operations. This documentation is specific to the 2018-08-01 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 */).

  • AcceptGrant ( array $params = [] )

    Accepts the specified grant.

  • CheckInLicense ( array $params = [] )

    Checks in the specified license.

  • CheckoutBorrowLicense ( array $params = [] )

    Checks out the specified license for offline use.

  • CheckoutLicense ( array $params = [] )

    Checks out the specified license.

  • CreateGrant ( array $params = [] )

    Creates a grant for the specified license.

  • CreateGrantVersion ( array $params = [] )

    Creates a new version of the specified grant.

  • CreateLicense ( array $params = [] )

    Creates a license.

  • CreateLicenseConfiguration ( array $params = [] )

    Creates a license configuration.

  • CreateLicenseConversionTaskForResource ( array $params = [] )

    Creates a new license conversion task.

  • CreateLicenseManagerReportGenerator ( array $params = [] )

    Creates a report generator.

  • CreateLicenseVersion ( array $params = [] )

    Creates a new version of the specified license.

  • CreateToken ( array $params = [] )

    Creates a long-lived token.

  • DeleteGrant ( array $params = [] )

    Deletes the specified grant.

  • DeleteLicense ( array $params = [] )

    Deletes the specified license.

  • DeleteLicenseConfiguration ( array $params = [] )

    Deletes the specified license configuration.

  • DeleteLicenseManagerReportGenerator ( array $params = [] )

    Deletes the specified report generator.

  • DeleteToken ( array $params = [] )

    Deletes the specified token.

  • ExtendLicenseConsumption ( array $params = [] )

    Extends the expiration date for license consumption.

  • GetAccessToken ( array $params = [] )

    Gets a temporary access token to use with AssumeRoleWithWebIdentity.

  • GetGrant ( array $params = [] )

    Gets detailed information about the specified grant.

  • GetLicense ( array $params = [] )

    Gets detailed information about the specified license.

  • GetLicenseConfiguration ( array $params = [] )

    Gets detailed information about the specified license configuration.

  • GetLicenseConversionTask ( array $params = [] )

    Gets information about the specified license type conversion task.

  • GetLicenseManagerReportGenerator ( array $params = [] )

    Gets information about the specified report generator.

  • GetLicenseUsage ( array $params = [] )

    Gets detailed information about the usage of the specified license.

  • GetServiceSettings ( array $params = [] )

    Gets the License Manager settings for the current Region.

  • ListAssociationsForLicenseConfiguration ( array $params = [] )

    Lists the resource associations for the specified license configuration.

  • ListDistributedGrants ( array $params = [] )

    Lists the grants distributed for the specified license.

  • ListFailuresForLicenseConfigurationOperations ( array $params = [] )

    Lists the license configuration operations that failed.

  • ListLicenseConfigurations ( array $params = [] )

    Lists the license configurations for your account.

  • ListLicenseConversionTasks ( array $params = [] )

    Lists the license type conversion tasks for your account.

  • ListLicenseManagerReportGenerators ( array $params = [] )

    Lists the report generators for your account.

  • ListLicenseSpecificationsForResource ( array $params = [] )

    Describes the license configurations for the specified resource.

  • ListLicenseVersions ( array $params = [] )

    Lists all versions of the specified license.

  • ListLicenses ( array $params = [] )

    Lists the licenses for your account.

  • ListReceivedGrants ( array $params = [] )

    Lists grants that are received but not accepted.

  • ListReceivedGrantsForOrganization ( array $params = [] )

    Lists the grants received for all accounts in the organization.

  • ListReceivedLicenses ( array $params = [] )

    Lists received licenses.

  • ListReceivedLicensesForOrganization ( array $params = [] )

    Lists the licenses received for all accounts in the organization.

  • ListResourceInventory ( array $params = [] )

    Lists resources managed using Systems Manager inventory.

  • ListTagsForResource ( array $params = [] )

    Lists the tags for the specified license configuration.

  • ListTokens ( array $params = [] )

    Lists your tokens.

  • ListUsageForLicenseConfiguration ( array $params = [] )

    Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time.

  • RejectGrant ( array $params = [] )

    Rejects the specified grant.

  • TagResource ( array $params = [] )

    Adds the specified tags to the specified license configuration.

  • UntagResource ( array $params = [] )

    Removes the specified tags from the specified license configuration.

  • UpdateLicenseConfiguration ( array $params = [] )

    Modifies the attributes of an existing license configuration.

  • UpdateLicenseManagerReportGenerator ( array $params = [] )

    Updates a report generator.

  • UpdateLicenseSpecificationsForResource ( array $params = [] )

    Adds or removes the specified license configurations for the specified Amazon Web Services resource.

  • UpdateServiceSettings ( array $params = [] )

    Updates License Manager settings for the current Region.

Operations

AcceptGrant

$result = $client->acceptGrant([/* ... */]);
$promise = $client->acceptGrantAsync([/* ... */]);

Accepts the specified grant.

Parameter Syntax

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

Parameter Details

Members
GrantArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the grant.

Result Syntax

[
    'GrantArn' => '<string>',
    'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
    'Version' => '<string>',
]

Result Details

Members
GrantArn
  • Type: string

Grant ARN.

Status
  • Type: string

Grant status.

Version
  • Type: string

Grant version.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

CheckInLicense

$result = $client->checkInLicense([/* ... */]);
$promise = $client->checkInLicenseAsync([/* ... */]);

Checks in the specified license. Check in a license when it is no longer in use.

Parameter Syntax

$result = $client->checkInLicense([
    'Beneficiary' => '<string>',
    'LicenseConsumptionToken' => '<string>', // REQUIRED
]);

Parameter Details

Members
Beneficiary
  • Type: string

License beneficiary.

LicenseConsumptionToken
  • Required: Yes
  • Type: string

License consumption token.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceNotFoundException:

    The resource cannot be found.

  • ConflictException:

    There was a conflict processing the request. Try your request again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ServerInternalException:

    The server experienced an internal error. Try again.

CheckoutBorrowLicense

$result = $client->checkoutBorrowLicense([/* ... */]);
$promise = $client->checkoutBorrowLicenseAsync([/* ... */]);

Checks out the specified license for offline use.

Parameter Syntax

$result = $client->checkoutBorrowLicense([
    'CheckoutMetadata' => [
        [
            'Name' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'ClientToken' => '<string>', // REQUIRED
    'DigitalSignatureMethod' => 'JWT_PS384', // REQUIRED
    'Entitlements' => [ // REQUIRED
        [
            'Name' => '<string>', // REQUIRED
            'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'LicenseArn' => '<string>', // REQUIRED
    'NodeId' => '<string>',
]);

Parameter Details

Members
CheckoutMetadata
  • Type: Array of Metadata structures

Information about constraints.

ClientToken
  • Required: Yes
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

DigitalSignatureMethod
  • Required: Yes
  • Type: string

Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.

Entitlements
  • Required: Yes
  • Type: Array of EntitlementData structures

License entitlements. Partial checkouts are not supported.

LicenseArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.

NodeId
  • Type: string

Node ID.

Result Syntax

[
    'CheckoutMetadata' => [
        [
            'Name' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'EntitlementsAllowed' => [
        [
            'Name' => '<string>',
            'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Expiration' => '<string>',
    'IssuedAt' => '<string>',
    'LicenseArn' => '<string>',
    'LicenseConsumptionToken' => '<string>',
    'NodeId' => '<string>',
    'SignedToken' => '<string>',
]

Result Details

Members
CheckoutMetadata
  • Type: Array of Metadata structures

Information about constraints.

EntitlementsAllowed
  • Type: Array of EntitlementData structures

Allowed license entitlements.

Expiration
  • Type: string

Date and time at which the license checkout expires.

IssuedAt
  • Type: string

Date and time at which the license checkout is issued.

LicenseArn
  • Type: string

Amazon Resource Name (ARN) of the license.

LicenseConsumptionToken
  • Type: string

License consumption token.

NodeId
  • Type: string

Node ID.

SignedToken
  • Type: string

Signed token.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceNotFoundException:

    The resource cannot be found.

  • NoEntitlementsAllowedException:

    There are no entitlements found for this license, or the entitlement maximum count is reached.

  • EntitlementNotAllowedException:

    The entitlement is not allowed.

  • UnsupportedDigitalSignatureMethodException:

    The digital signature method is unsupported. Try your request again.

  • RedirectException:

    This is not the correct Region for the resource. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ServerInternalException:

    The server experienced an internal error. Try again.

CheckoutLicense

$result = $client->checkoutLicense([/* ... */]);
$promise = $client->checkoutLicenseAsync([/* ... */]);

Checks out the specified license.

If the account that created the license is the same that is performing the check out, you must specify the account as the beneficiary.

Parameter Syntax

$result = $client->checkoutLicense([
    'Beneficiary' => '<string>',
    'CheckoutType' => 'PROVISIONAL|PERPETUAL', // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'Entitlements' => [ // REQUIRED
        [
            'Name' => '<string>', // REQUIRED
            'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'KeyFingerprint' => '<string>', // REQUIRED
    'NodeId' => '<string>',
    'ProductSKU' => '<string>', // REQUIRED
]);

Parameter Details

Members
Beneficiary
  • Type: string

License beneficiary.

CheckoutType
  • Required: Yes
  • Type: string

Checkout type.

ClientToken
  • Required: Yes
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Entitlements
  • Required: Yes
  • Type: Array of EntitlementData structures

License entitlements.

KeyFingerprint
  • Required: Yes
  • Type: string

Key fingerprint identifying the license.

NodeId
  • Type: string

Node ID.

ProductSKU
  • Required: Yes
  • Type: string

Product SKU.

Result Syntax

[
    'CheckoutType' => 'PROVISIONAL|PERPETUAL',
    'EntitlementsAllowed' => [
        [
            'Name' => '<string>',
            'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Expiration' => '<string>',
    'IssuedAt' => '<string>',
    'LicenseArn' => '<string>',
    'LicenseConsumptionToken' => '<string>',
    'NodeId' => '<string>',
    'SignedToken' => '<string>',
]

Result Details

Members
CheckoutType
  • Type: string

Checkout type.

EntitlementsAllowed
  • Type: Array of EntitlementData structures

Allowed license entitlements.

Expiration
  • Type: string

Date and time at which the license checkout expires.

IssuedAt
  • Type: string

Date and time at which the license checkout is issued.

LicenseArn
  • Type: string

Amazon Resource Name (ARN) of the checkout license.

LicenseConsumptionToken
  • Type: string

License consumption token.

NodeId
  • Type: string

Node ID.

SignedToken
  • Type: string

Signed token.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceNotFoundException:

    The resource cannot be found.

  • NoEntitlementsAllowedException:

    There are no entitlements found for this license, or the entitlement maximum count is reached.

  • UnsupportedDigitalSignatureMethodException:

    The digital signature method is unsupported. Try your request again.

  • RedirectException:

    This is not the correct Region for the resource. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ServerInternalException:

    The server experienced an internal error. Try again.

CreateGrant

$result = $client->createGrant([/* ... */]);
$promise = $client->createGrantAsync([/* ... */]);

Creates a grant for the specified license. A grant shares the use of license entitlements with specific Amazon Web Services accounts.

Parameter Syntax

$result = $client->createGrant([
    'AllowedOperations' => ['<string>', ...], // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'GrantName' => '<string>', // REQUIRED
    'HomeRegion' => '<string>', // REQUIRED
    'LicenseArn' => '<string>', // REQUIRED
    'Principals' => ['<string>', ...], // REQUIRED
]);

Parameter Details

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

Allowed operations for the grant.

ClientToken
  • Required: Yes
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

GrantName
  • Required: Yes
  • Type: string

Grant name.

HomeRegion
  • Required: Yes
  • Type: string

Home Region of the grant.

LicenseArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license.

Principals
  • Required: Yes
  • Type: Array of strings

The grant principals. This value should be specified as an Amazon Resource Name (ARN).

Result Syntax

[
    'GrantArn' => '<string>',
    'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
    'Version' => '<string>',
]

Result Details

Members
GrantArn
  • Type: string

Grant ARN.

Status
  • Type: string

Grant status.

Version
  • Type: string

Grant version.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • AccessDeniedException:

    Access to resource denied.

CreateGrantVersion

$result = $client->createGrantVersion([/* ... */]);
$promise = $client->createGrantVersionAsync([/* ... */]);

Creates a new version of the specified grant.

Parameter Syntax

$result = $client->createGrantVersion([
    'AllowedOperations' => ['<string>', ...],
    'ClientToken' => '<string>', // REQUIRED
    'GrantArn' => '<string>', // REQUIRED
    'GrantName' => '<string>',
    'SourceVersion' => '<string>',
    'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
    'StatusReason' => '<string>',
]);

Parameter Details

Members
AllowedOperations
  • Type: Array of strings

Allowed operations for the grant.

ClientToken
  • Required: Yes
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

GrantArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the grant.

GrantName
  • Type: string

Grant name.

SourceVersion
  • Type: string

Current version of the grant.

Status
  • Type: string

Grant status.

StatusReason
  • Type: string

Grant status reason.

Result Syntax

[
    'GrantArn' => '<string>',
    'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
    'Version' => '<string>',
]

Result Details

Members
GrantArn
  • Type: string

Grant ARN.

Status
  • Type: string

Grant status.

Version
  • Type: string

New version of the grant.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

CreateLicense

$result = $client->createLicense([/* ... */]);
$promise = $client->createLicenseAsync([/* ... */]);

Creates a license.

Parameter Syntax

$result = $client->createLicense([
    'Beneficiary' => '<string>', // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'ConsumptionConfiguration' => [ // REQUIRED
        'BorrowConfiguration' => [
            'AllowEarlyCheckIn' => true || false, // REQUIRED
            'MaxTimeToLiveInMinutes' => <integer>, // REQUIRED
        ],
        'ProvisionalConfiguration' => [
            'MaxTimeToLiveInMinutes' => <integer>, // REQUIRED
        ],
        'RenewType' => 'None|Weekly|Monthly',
    ],
    'Entitlements' => [ // REQUIRED
        [
            'AllowCheckIn' => true || false,
            'MaxCount' => <integer>,
            'Name' => '<string>', // REQUIRED
            'Overage' => true || false,
            'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'HomeRegion' => '<string>', // REQUIRED
    'Issuer' => [ // REQUIRED
        'Name' => '<string>', // REQUIRED
        'SignKey' => '<string>',
    ],
    'LicenseMetadata' => [
        [
            'Name' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'LicenseName' => '<string>', // REQUIRED
    'ProductName' => '<string>', // REQUIRED
    'ProductSKU' => '<string>', // REQUIRED
    'Validity' => [ // REQUIRED
        'Begin' => '<string>', // REQUIRED
        'End' => '<string>',
    ],
]);

Parameter Details

Members
Beneficiary
  • Required: Yes
  • Type: string

License beneficiary.

ClientToken
  • Required: Yes
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

ConsumptionConfiguration
  • Required: Yes
  • Type: ConsumptionConfiguration structure

Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.

Entitlements
  • Required: Yes
  • Type: Array of Entitlement structures

License entitlements.

HomeRegion
  • Required: Yes
  • Type: string

Home Region for the license.

Issuer
  • Required: Yes
  • Type: Issuer structure

License issuer.

LicenseMetadata
  • Type: Array of Metadata structures

Information about the license.

LicenseName
  • Required: Yes
  • Type: string

License name.

ProductName
  • Required: Yes
  • Type: string

Product name.

ProductSKU
  • Required: Yes
  • Type: string

Product SKU.

Validity
  • Required: Yes
  • Type: DatetimeRange structure

Date and time range during which the license is valid, in ISO8601-UTC format.

Result Syntax

[
    'LicenseArn' => '<string>',
    'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
    'Version' => '<string>',
]

Result Details

Members
LicenseArn
  • Type: string

Amazon Resource Name (ARN) of the license.

Status
  • Type: string

License status.

Version
  • Type: string

License version.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • RedirectException:

    This is not the correct Region for the resource. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ServerInternalException:

    The server experienced an internal error. Try again.

CreateLicenseConfiguration

$result = $client->createLicenseConfiguration([/* ... */]);
$promise = $client->createLicenseConfigurationAsync([/* ... */]);

Creates a license configuration.

A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used.

Parameter Syntax

$result = $client->createLicenseConfiguration([
    'Description' => '<string>',
    'DisassociateWhenNotFound' => true || false,
    'LicenseCount' => <integer>,
    'LicenseCountHardLimit' => true || false,
    'LicenseCountingType' => 'vCPU|Instance|Core|Socket', // REQUIRED
    'LicenseRules' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'ProductInformationList' => [
        [
            'ProductInformationFilterList' => [ // REQUIRED
                [
                    'ProductInformationFilterComparator' => '<string>', // REQUIRED
                    'ProductInformationFilterName' => '<string>', // REQUIRED
                    'ProductInformationFilterValue' => ['<string>', ...],
                ],
                // ...
            ],
            'ResourceType' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
Description
  • Type: string

Description of the license configuration.

DisassociateWhenNotFound
  • Type: boolean

When true, disassociates a resource when software is uninstalled.

LicenseCount
  • Type: long (int|float)

Number of licenses managed by the license configuration.

LicenseCountHardLimit
  • Type: boolean

Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.

LicenseCountingType
  • Required: Yes
  • Type: string

Dimension used to track the license inventory.

LicenseRules
  • Type: Array of strings

License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.

  • Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores

  • Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpus

  • Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets

  • vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus

The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.

Name
  • Required: Yes
  • Type: string

Name of the license configuration.

ProductInformationList
  • Type: Array of ProductInformation structures

Product information.

Tags
  • Type: Array of Tag structures

Tags to add to the license configuration.

Result Syntax

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

Result Details

Members
LicenseConfigurationArn
  • Type: string

Amazon Resource Name (ARN) of the license configuration.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

CreateLicenseConversionTaskForResource

$result = $client->createLicenseConversionTaskForResource([/* ... */]);
$promise = $client->createLicenseConversionTaskForResourceAsync([/* ... */]);

Creates a new license conversion task.

Parameter Syntax

$result = $client->createLicenseConversionTaskForResource([
    'DestinationLicenseContext' => [ // REQUIRED
        'UsageOperation' => '<string>',
    ],
    'ResourceArn' => '<string>', // REQUIRED
    'SourceLicenseContext' => [ // REQUIRED
        'UsageOperation' => '<string>',
    ],
]);

Parameter Details

Members
DestinationLicenseContext
  • Required: Yes
  • Type: LicenseConversionContext structure

Information that identifies the license type you are converting to. For the structure of the destination license, see Convert a license type using the Amazon Web Services CLI in the License Manager User Guide.

ResourceArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the resource you are converting the license type for.

SourceLicenseContext
  • Required: Yes
  • Type: LicenseConversionContext structure

Information that identifies the license type you are converting from. For the structure of the source license, see Convert a license type using the Amazon Web Services CLI in the License Manager User Guide.

Result Syntax

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

Result Details

Members
LicenseConversionTaskId
  • Type: string

The ID of the created license type conversion task.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ValidationException:

    The provided input is not valid. Try your request again.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

CreateLicenseManagerReportGenerator

$result = $client->createLicenseManagerReportGenerator([/* ... */]);
$promise = $client->createLicenseManagerReportGeneratorAsync([/* ... */]);

Creates a report generator.

Parameter Syntax

$result = $client->createLicenseManagerReportGenerator([
    'ClientToken' => '<string>', // REQUIRED
    'Description' => '<string>',
    'ReportContext' => [ // REQUIRED
        'licenseConfigurationArns' => ['<string>', ...], // REQUIRED
    ],
    'ReportFrequency' => [ // REQUIRED
        'period' => 'DAY|WEEK|MONTH',
        'value' => <integer>,
    ],
    'ReportGeneratorName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Type' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ClientToken
  • Required: Yes
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Description
  • Type: string

Description of the report generator.

ReportContext
  • Required: Yes
  • Type: ReportContext structure

Defines the type of license configuration the report generator tracks.

ReportFrequency
  • Required: Yes
  • Type: ReportFrequency structure

Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.

ReportGeneratorName
  • Required: Yes
  • Type: string

Name of the report generator.

Tags
  • Type: Array of Tag structures

Tags to add to the report generator.

Type
  • Required: Yes
  • Type: Array of strings

Type of reports to generate. The following report types an be generated:

  • License configuration report - Reports the number and details of consumed licenses for a license configuration.

  • Resource report - Reports the tracked licenses and resource consumption for a license configuration.

Result Syntax

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

Result Details

Members
LicenseManagerReportGeneratorArn
  • Type: string

The Amazon Resource Name (ARN) of the new report generator.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • AccessDeniedException:

    Access to resource denied.

  • ResourceNotFoundException:

    The resource cannot be found.

CreateLicenseVersion

$result = $client->createLicenseVersion([/* ... */]);
$promise = $client->createLicenseVersionAsync([/* ... */]);

Creates a new version of the specified license.

Parameter Syntax

$result = $client->createLicenseVersion([
    'ClientToken' => '<string>', // REQUIRED
    'ConsumptionConfiguration' => [ // REQUIRED
        'BorrowConfiguration' => [
            'AllowEarlyCheckIn' => true || false, // REQUIRED
            'MaxTimeToLiveInMinutes' => <integer>, // REQUIRED
        ],
        'ProvisionalConfiguration' => [
            'MaxTimeToLiveInMinutes' => <integer>, // REQUIRED
        ],
        'RenewType' => 'None|Weekly|Monthly',
    ],
    'Entitlements' => [ // REQUIRED
        [
            'AllowCheckIn' => true || false,
            'MaxCount' => <integer>,
            'Name' => '<string>', // REQUIRED
            'Overage' => true || false,
            'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'HomeRegion' => '<string>', // REQUIRED
    'Issuer' => [ // REQUIRED
        'Name' => '<string>', // REQUIRED
        'SignKey' => '<string>',
    ],
    'LicenseArn' => '<string>', // REQUIRED
    'LicenseMetadata' => [
        [
            'Name' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'LicenseName' => '<string>', // REQUIRED
    'ProductName' => '<string>', // REQUIRED
    'SourceVersion' => '<string>',
    'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED', // REQUIRED
    'Validity' => [ // REQUIRED
        'Begin' => '<string>', // REQUIRED
        'End' => '<string>',
    ],
]);

Parameter Details

Members
ClientToken
  • Required: Yes
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

ConsumptionConfiguration
  • Required: Yes
  • Type: ConsumptionConfiguration structure

Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.

Entitlements
  • Required: Yes
  • Type: Array of Entitlement structures

License entitlements.

HomeRegion
  • Required: Yes
  • Type: string

Home Region of the license.

Issuer
  • Required: Yes
  • Type: Issuer structure

License issuer.

LicenseArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license.

LicenseMetadata
  • Type: Array of Metadata structures

Information about the license.

LicenseName
  • Required: Yes
  • Type: string

License name.

ProductName
  • Required: Yes
  • Type: string

Product name.

SourceVersion
  • Type: string

Current version of the license.

Status
  • Required: Yes
  • Type: string

License status.

Validity
  • Required: Yes
  • Type: DatetimeRange structure

Date and time range during which the license is valid, in ISO8601-UTC format.

Result Syntax

[
    'LicenseArn' => '<string>',
    'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
    'Version' => '<string>',
]

Result Details

Members
LicenseArn
  • Type: string

License ARN.

Status
  • Type: string

License status.

Version
  • Type: string

New version of the license.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • AccessDeniedException:

    Access to resource denied.

  • ResourceNotFoundException:

    The resource cannot be found.

  • RedirectException:

    This is not the correct Region for the resource. Try again.

  • ConflictException:

    There was a conflict processing the request. Try your request again.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

CreateToken

$result = $client->createToken([/* ... */]);
$promise = $client->createTokenAsync([/* ... */]);

Creates a long-lived token.

A refresh token is a JWT token used to get an access token. With an access token, you can call AssumeRoleWithWebIdentity to get role credentials that you can use to call License Manager to manage the specified license.

Parameter Syntax

$result = $client->createToken([
    'ClientToken' => '<string>', // REQUIRED
    'ExpirationInDays' => <integer>,
    'LicenseArn' => '<string>', // REQUIRED
    'RoleArns' => ['<string>', ...],
    'TokenProperties' => ['<string>', ...],
]);

Parameter Details

Members
ClientToken
  • Required: Yes
  • Type: string

Idempotency token, valid for 10 minutes.

ExpirationInDays
  • Type: int

Token expiration, in days, counted from token creation. The default is 365 days.

LicenseArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.

RoleArns
  • Type: Array of strings

Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.

TokenProperties
  • Type: Array of strings

Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.

Result Syntax

[
    'Token' => '<string>',
    'TokenId' => '<string>',
    'TokenType' => 'REFRESH_TOKEN',
]

Result Details

Members
Token
  • Type: string

Refresh token, encoded as a JWT token.

TokenId
  • Type: string

Token ID.

TokenType
  • Type: string

Token type.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • ResourceNotFoundException:

    The resource cannot be found.

  • RedirectException:

    This is not the correct Region for the resource. Try again.

DeleteGrant

$result = $client->deleteGrant([/* ... */]);
$promise = $client->deleteGrantAsync([/* ... */]);

Deletes the specified grant.

Parameter Syntax

$result = $client->deleteGrant([
    'GrantArn' => '<string>', // REQUIRED
    'StatusReason' => '<string>',
    'Version' => '<string>', // REQUIRED
]);

Parameter Details

Members
GrantArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the grant.

StatusReason
  • Type: string

The Status reason for the delete request.

Version
  • Required: Yes
  • Type: string

Current version of the grant.

Result Syntax

[
    'GrantArn' => '<string>',
    'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
    'Version' => '<string>',
]

Result Details

Members
GrantArn
  • Type: string

Grant ARN.

Status
  • Type: string

Grant status.

Version
  • Type: string

Grant version.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

DeleteLicense

$result = $client->deleteLicense([/* ... */]);
$promise = $client->deleteLicenseAsync([/* ... */]);

Deletes the specified license.

Parameter Syntax

$result = $client->deleteLicense([
    'LicenseArn' => '<string>', // REQUIRED
    'SourceVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members
LicenseArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license.

SourceVersion
  • Required: Yes
  • Type: string

Current version of the license.

Result Syntax

[
    'DeletionDate' => '<string>',
    'Status' => 'PENDING_DELETE|DELETED',
]

Result Details

Members
DeletionDate
  • Type: string

Date when the license is deleted.

Status
  • Type: string

License status.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • RedirectException:

    This is not the correct Region for the resource. Try again.

  • ConflictException:

    There was a conflict processing the request. Try your request again.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

DeleteLicenseConfiguration

$result = $client->deleteLicenseConfiguration([/* ... */]);
$promise = $client->deleteLicenseConfigurationAsync([/* ... */]);

Deletes the specified license configuration.

You cannot delete a license configuration that is in use.

Parameter Syntax

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

Parameter Details

Members
LicenseConfigurationArn
  • Required: Yes
  • Type: string

ID of the license configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

DeleteLicenseManagerReportGenerator

$result = $client->deleteLicenseManagerReportGenerator([/* ... */]);
$promise = $client->deleteLicenseManagerReportGeneratorAsync([/* ... */]);

Deletes the specified report generator.

This action deletes the report generator, which stops it from generating future reports. The action cannot be reversed. It has no effect on the previous reports from this generator.

Parameter Syntax

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

Parameter Details

Members
LicenseManagerReportGeneratorArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the report generator to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • AccessDeniedException:

    Access to resource denied.

  • ResourceNotFoundException:

    The resource cannot be found.

DeleteToken

$result = $client->deleteToken([/* ... */]);
$promise = $client->deleteTokenAsync([/* ... */]);

Deletes the specified token. Must be called in the license home Region.

Parameter Syntax

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

Parameter Details

Members
TokenId
  • Required: Yes
  • Type: string

Token ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • ResourceNotFoundException:

    The resource cannot be found.

  • RedirectException:

    This is not the correct Region for the resource. Try again.

ExtendLicenseConsumption

$result = $client->extendLicenseConsumption([/* ... */]);
$promise = $client->extendLicenseConsumptionAsync([/* ... */]);

Extends the expiration date for license consumption.

Parameter Syntax

$result = $client->extendLicenseConsumption([
    'DryRun' => true || false,
    'LicenseConsumptionToken' => '<string>', // REQUIRED
]);

Parameter Details

Members
DryRun
  • Type: boolean

Checks whether you have the required permissions for the action, without actually making the request. Provides an error response if you do not have the required permissions.

LicenseConsumptionToken
  • Required: Yes
  • Type: string

License consumption token.

Result Syntax

[
    'Expiration' => '<string>',
    'LicenseConsumptionToken' => '<string>',
]

Result Details

Members
Expiration
  • Type: string

Date and time at which the license consumption expires.

LicenseConsumptionToken
  • Type: string

License consumption token.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • ResourceNotFoundException:

    The resource cannot be found.

GetAccessToken

$result = $client->getAccessToken([/* ... */]);
$promise = $client->getAccessTokenAsync([/* ... */]);

Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are valid for one hour.

Parameter Syntax

$result = $client->getAccessToken([
    'Token' => '<string>', // REQUIRED
    'TokenProperties' => ['<string>', ...],
]);

Parameter Details

Members
Token
  • Required: Yes
  • Type: string

Refresh token, encoded as a JWT token.

TokenProperties
  • Type: Array of strings

Token properties to validate against those present in the JWT token.

Result Syntax

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

Result Details

Members
AccessToken
  • Type: string

Temporary access token.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ServerInternalException:

    The server experienced an internal error. Try again.

GetGrant

$result = $client->getGrant([/* ... */]);
$promise = $client->getGrantAsync([/* ... */]);

Gets detailed information about the specified grant.

Parameter Syntax

$result = $client->getGrant([
    'GrantArn' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members
GrantArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the grant.

Version
  • Type: string

Grant version.

Result Syntax

[
    'Grant' => [
        'GrantArn' => '<string>',
        'GrantName' => '<string>',
        'GrantStatus' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
        'GrantedOperations' => ['<string>', ...],
        'GranteePrincipalArn' => '<string>',
        'HomeRegion' => '<string>',
        'LicenseArn' => '<string>',
        'ParentArn' => '<string>',
        'StatusReason' => '<string>',
        'Version' => '<string>',
    ],
]

Result Details

Members
Grant
  • Type: Grant structure

Grant details.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

GetLicense

$result = $client->getLicense([/* ... */]);
$promise = $client->getLicenseAsync([/* ... */]);

Gets detailed information about the specified license.

Parameter Syntax

$result = $client->getLicense([
    'LicenseArn' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members
LicenseArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license.

Version
  • Type: string

License version.

Result Syntax

[
    'License' => [
        'Beneficiary' => '<string>',
        'ConsumptionConfiguration' => [
            'BorrowConfiguration' => [
                'AllowEarlyCheckIn' => true || false,
                'MaxTimeToLiveInMinutes' => <integer>,
            ],
            'ProvisionalConfiguration' => [
                'MaxTimeToLiveInMinutes' => <integer>,
            ],
            'RenewType' => 'None|Weekly|Monthly',
        ],
        'CreateTime' => '<string>',
        'Entitlements' => [
            [
                'AllowCheckIn' => true || false,
                'MaxCount' => <integer>,
                'Name' => '<string>',
                'Overage' => true || false,
                'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
                'Value' => '<string>',
            ],
            // ...
        ],
        'HomeRegion' => '<string>',
        'Issuer' => [
            'KeyFingerprint' => '<string>',
            'Name' => '<string>',
            'SignKey' => '<string>',
        ],
        'LicenseArn' => '<string>',
        'LicenseMetadata' => [
            [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'LicenseName' => '<string>',
        'ProductName' => '<string>',
        'ProductSKU' => '<string>',
        'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
        'Validity' => [
            'Begin' => '<string>',
            'End' => '<string>',
        ],
        'Version' => '<string>',
    ],
]

Result Details

Members
License
  • Type: License structure

License details.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ServerInternalException:

    The server experienced an internal error. Try again.

GetLicenseConfiguration

$result = $client->getLicenseConfiguration([/* ... */]);
$promise = $client->getLicenseConfigurationAsync([/* ... */]);

Gets detailed information about the specified license configuration.

Parameter Syntax

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

Parameter Details

Members
LicenseConfigurationArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license configuration.

Result Syntax

[
    'AutomatedDiscoveryInformation' => [
        'LastRunTime' => <DateTime>,
    ],
    'ConsumedLicenseSummaryList' => [
        [
            'ConsumedLicenses' => <integer>,
            'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
        ],
        // ...
    ],
    'ConsumedLicenses' => <integer>,
    'Description' => '<string>',
    'DisassociateWhenNotFound' => true || false,
    'LicenseConfigurationArn' => '<string>',
    'LicenseConfigurationId' => '<string>',
    'LicenseCount' => <integer>,
    'LicenseCountHardLimit' => true || false,
    'LicenseCountingType' => 'vCPU|Instance|Core|Socket',
    'LicenseRules' => ['<string>', ...],
    'ManagedResourceSummaryList' => [
        [
            'AssociationCount' => <integer>,
            'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
        ],
        // ...
    ],
    'Name' => '<string>',
    'OwnerAccountId' => '<string>',
    'ProductInformationList' => [
        [
            'ProductInformationFilterList' => [
                [
                    'ProductInformationFilterComparator' => '<string>',
                    'ProductInformationFilterName' => '<string>',
                    'ProductInformationFilterValue' => ['<string>', ...],
                ],
                // ...
            ],
            'ResourceType' => '<string>',
        ],
        // ...
    ],
    'Status' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
AutomatedDiscoveryInformation
  • Type: AutomatedDiscoveryInformation structure

Automated discovery information.

ConsumedLicenseSummaryList
  • Type: Array of ConsumedLicenseSummary structures

Summaries of the licenses consumed by resources.

ConsumedLicenses
  • Type: long (int|float)

Number of licenses assigned to resources.

Description
  • Type: string

Description of the license configuration.

DisassociateWhenNotFound
  • Type: boolean

When true, disassociates a resource when software is uninstalled.

LicenseConfigurationArn
  • Type: string

Amazon Resource Name (ARN) of the license configuration.

LicenseConfigurationId
  • Type: string

Unique ID for the license configuration.

LicenseCount
  • Type: long (int|float)

Number of available licenses.

LicenseCountHardLimit
  • Type: boolean

Sets the number of available licenses as a hard limit.

LicenseCountingType
  • Type: string

Dimension for which the licenses are counted.

LicenseRules
  • Type: Array of strings

License rules.

ManagedResourceSummaryList
  • Type: Array of ManagedResourceSummary structures

Summaries of the managed resources.

Name
  • Type: string

Name of the license configuration.

OwnerAccountId
  • Type: string

Account ID of the owner of the license configuration.

ProductInformationList
  • Type: Array of ProductInformation structures

Product information.

Status
  • Type: string

License configuration status.

Tags
  • Type: Array of Tag structures

Tags for the license configuration.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

GetLicenseConversionTask

$result = $client->getLicenseConversionTask([/* ... */]);
$promise = $client->getLicenseConversionTaskAsync([/* ... */]);

Gets information about the specified license type conversion task.

Parameter Syntax

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

Parameter Details

Members
LicenseConversionTaskId
  • Required: Yes
  • Type: string

ID of the license type conversion task to retrieve information on.

Result Syntax

[
    'DestinationLicenseContext' => [
        'UsageOperation' => '<string>',
    ],
    'EndTime' => <DateTime>,
    'LicenseConversionTaskId' => '<string>',
    'LicenseConversionTime' => <DateTime>,
    'ResourceArn' => '<string>',
    'SourceLicenseContext' => [
        'UsageOperation' => '<string>',
    ],
    'StartTime' => <DateTime>,
    'Status' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    'StatusMessage' => '<string>',
]

Result Details

Members
DestinationLicenseContext
  • Type: LicenseConversionContext structure

Information about the license type converted to.

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

Time at which the license type conversion task was completed.

LicenseConversionTaskId
  • Type: string

ID of the license type conversion task.

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

Amount of time to complete the license type conversion.

ResourceArn
  • Type: string

Amazon Resource Names (ARN) of the resources the license conversion task is associated with.

SourceLicenseContext
  • Type: LicenseConversionContext structure

Information about the license type converted from.

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

Time at which the license type conversion task was started .

Status
  • Type: string

Status of the license type conversion task.

StatusMessage
  • Type: string

The status message for the conversion task.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

GetLicenseManagerReportGenerator

$result = $client->getLicenseManagerReportGenerator([/* ... */]);
$promise = $client->getLicenseManagerReportGeneratorAsync([/* ... */]);

Gets information about the specified report generator.

Parameter Syntax

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

Parameter Details

Members
LicenseManagerReportGeneratorArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the report generator.

Result Syntax

[
    'ReportGenerator' => [
        'CreateTime' => '<string>',
        'Description' => '<string>',
        'LastReportGenerationTime' => '<string>',
        'LastRunFailureReason' => '<string>',
        'LastRunStatus' => '<string>',
        'LicenseManagerReportGeneratorArn' => '<string>',
        'ReportContext' => [
            'licenseConfigurationArns' => ['<string>', ...],
        ],
        'ReportCreatorAccount' => '<string>',
        'ReportFrequency' => [
            'period' => 'DAY|WEEK|MONTH',
            'value' => <integer>,
        ],
        'ReportGeneratorName' => '<string>',
        'ReportType' => ['<string>', ...],
        'S3Location' => [
            'bucket' => '<string>',
            'keyPrefix' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
ReportGenerator
  • Type: ReportGenerator structure

A report generator that creates periodic reports about your license configurations.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • AccessDeniedException:

    Access to resource denied.

  • ResourceNotFoundException:

    The resource cannot be found.

GetLicenseUsage

$result = $client->getLicenseUsage([/* ... */]);
$promise = $client->getLicenseUsageAsync([/* ... */]);

Gets detailed information about the usage of the specified license.

Parameter Syntax

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

Parameter Details

Members
LicenseArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license.

Result Syntax

[
    'LicenseUsage' => [
        'EntitlementUsages' => [
            [
                'ConsumedValue' => '<string>',
                'MaxCount' => '<string>',
                'Name' => '<string>',
                'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
            ],
            // ...
        ],
    ],
]

Result Details

Members
LicenseUsage
  • Type: LicenseUsage structure

License usage details.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ServerInternalException:

    The server experienced an internal error. Try again.

GetServiceSettings

$result = $client->getServiceSettings([/* ... */]);
$promise = $client->getServiceSettingsAsync([/* ... */]);

Gets the License Manager settings for the current Region.

Parameter Syntax

$result = $client->getServiceSettings([
]);

Parameter Details

Members

Result Syntax

[
    'EnableCrossAccountsDiscovery' => true || false,
    'LicenseManagerResourceShareArn' => '<string>',
    'OrganizationConfiguration' => [
        'EnableIntegration' => true || false,
    ],
    'S3BucketArn' => '<string>',
    'SnsTopicArn' => '<string>',
]

Result Details

Members
EnableCrossAccountsDiscovery
  • Type: boolean

Indicates whether cross-account discovery is enabled.

LicenseManagerResourceShareArn
  • Type: string

Amazon Resource Name (ARN) of the resource share. The License Manager management account provides member accounts with access to this share.

OrganizationConfiguration
  • Type: OrganizationConfiguration structure

Indicates whether Organizations is integrated with License Manager for cross-account discovery.

S3BucketArn
  • Type: string

Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.

SnsTopicArn
  • Type: string

SNS topic configured to receive notifications from License Manager.

Errors

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

ListAssociationsForLicenseConfiguration

$result = $client->listAssociationsForLicenseConfiguration([/* ... */]);
$promise = $client->listAssociationsForLicenseConfigurationAsync([/* ... */]);

Lists the resource associations for the specified license configuration.

Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance might not consume a license (depending on the license rules).

Parameter Syntax

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

Parameter Details

Members
LicenseConfigurationArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of a license configuration.

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'LicenseConfigurationAssociations' => [
        [
            'AmiAssociationScope' => '<string>',
            'AssociationTime' => <DateTime>,
            'ResourceArn' => '<string>',
            'ResourceOwnerId' => '<string>',
            'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
LicenseConfigurationAssociations
  • Type: Array of LicenseConfigurationAssociation structures

Information about the associations for the license configuration.

NextToken
  • Type: string

Token for the next set of results.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • FilterLimitExceededException:

    The request uses too many filters or too many filter values.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

ListDistributedGrants

$result = $client->listDistributedGrants([/* ... */]);
$promise = $client->listDistributedGrantsAsync([/* ... */]);

Lists the grants distributed for the specified license.

Parameter Syntax

$result = $client->listDistributedGrants([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'GrantArns' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of Filter structures

Filters to scope the results. The following filters are supported:

  • LicenseArn

  • GrantStatus

  • GranteePrincipalARN

  • ProductSKU

  • LicenseIssuerName

GrantArns
  • Type: Array of strings

Amazon Resource Names (ARNs) of the grants.

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'Grants' => [
        [
            'GrantArn' => '<string>',
            'GrantName' => '<string>',
            'GrantStatus' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
            'GrantedOperations' => ['<string>', ...],
            'GranteePrincipalArn' => '<string>',
            'HomeRegion' => '<string>',
            'LicenseArn' => '<string>',
            'ParentArn' => '<string>',
            'StatusReason' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Grants
  • Type: Array of Grant structures

Distributed grant details.

NextToken
  • Type: string

Token for the next set of results.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

ListFailuresForLicenseConfigurationOperations

$result = $client->listFailuresForLicenseConfigurationOperations([/* ... */]);
$promise = $client->listFailuresForLicenseConfigurationOperationsAsync([/* ... */]);

Lists the license configuration operations that failed.

Parameter Syntax

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

Parameter Details

Members
LicenseConfigurationArn
  • Required: Yes
  • Type: string

Amazon Resource Name of the license configuration.

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'LicenseOperationFailureList' => [
        [
            'ErrorMessage' => '<string>',
            'FailureTime' => <DateTime>,
            'MetadataList' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'OperationName' => '<string>',
            'OperationRequestedBy' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceOwnerId' => '<string>',
            'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
LicenseOperationFailureList
  • Type: Array of LicenseOperationFailure structures

License configuration operations that failed.

NextToken
  • Type: string

Token for the next set of results.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

ListLicenseConfigurations

$result = $client->listLicenseConfigurations([/* ... */]);
$promise = $client->listLicenseConfigurationsAsync([/* ... */]);

Lists the license configurations for your account.

Parameter Syntax

$result = $client->listLicenseConfigurations([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'LicenseConfigurationArns' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of Filter structures

Filters to scope the results. The following filters and logical operators are supported:

  • licenseCountingType - The dimension for which licenses are counted. Possible values are vCPU | Instance | Core | Socket. Logical operators are EQUALS | NOT_EQUALS.

  • enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used. Logical operators are EQUALS | NOT_EQUALS.

  • usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded. Logical operators are EQUALS | NOT_EQUALS.

LicenseConfigurationArns
  • Type: Array of strings

Amazon Resource Names (ARN) of the license configurations.

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'LicenseConfigurations' => [
        [
            'AutomatedDiscoveryInformation' => [
                'LastRunTime' => <DateTime>,
            ],
            'ConsumedLicenseSummaryList' => [
                [
                    'ConsumedLicenses' => <integer>,
                    'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
                ],
                // ...
            ],
            'ConsumedLicenses' => <integer>,
            'Description' => '<string>',
            'DisassociateWhenNotFound' => true || false,
            'LicenseConfigurationArn' => '<string>',
            'LicenseConfigurationId' => '<string>',
            'LicenseCount' => <integer>,
            'LicenseCountHardLimit' => true || false,
            'LicenseCountingType' => 'vCPU|Instance|Core|Socket',
            'LicenseRules' => ['<string>', ...],
            'ManagedResourceSummaryList' => [
                [
                    'AssociationCount' => <integer>,
                    'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
                ],
                // ...
            ],
            'Name' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProductInformationList' => [
                [
                    'ProductInformationFilterList' => [
                        [
                            'ProductInformationFilterComparator' => '<string>',
                            'ProductInformationFilterName' => '<string>',
                            'ProductInformationFilterValue' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'ResourceType' => '<string>',
                ],
                // ...
            ],
            'Status' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
LicenseConfigurations
  • Type: Array of LicenseConfiguration structures

Information about the license configurations.

NextToken
  • Type: string

Token for the next set of results.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • FilterLimitExceededException:

    The request uses too many filters or too many filter values.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

ListLicenseConversionTasks

$result = $client->listLicenseConversionTasks([/* ... */]);
$promise = $client->listLicenseConversionTasksAsync([/* ... */]);

Lists the license type conversion tasks for your account.

Parameter Syntax

$result = $client->listLicenseConversionTasks([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of Filter structures

Filters to scope the results. Valid filters are ResourceArns and Status.

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'LicenseConversionTasks' => [
        [
            'DestinationLicenseContext' => [
                'UsageOperation' => '<string>',
            ],
            'EndTime' => <DateTime>,
            'LicenseConversionTaskId' => '<string>',
            'LicenseConversionTime' => <DateTime>,
            'ResourceArn' => '<string>',
            'SourceLicenseContext' => [
                'UsageOperation' => '<string>',
            ],
            'StartTime' => <DateTime>,
            'Status' => 'IN_PROGRESS|SUCCEEDED|FAILED',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
LicenseConversionTasks
  • Type: Array of LicenseConversionTask structures

Information about the license configuration tasks for your account.

NextToken
  • Type: string

Token for the next set of results.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

ListLicenseManagerReportGenerators

$result = $client->listLicenseManagerReportGenerators([/* ... */]);
$promise = $client->listLicenseManagerReportGeneratorsAsync([/* ... */]);

Lists the report generators for your account.

Parameter Syntax

$result = $client->listLicenseManagerReportGenerators([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of Filter structures

Filters to scope the results. The following filters are supported:

  • LicenseConfigurationArn

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'ReportGenerators' => [
        [
            'CreateTime' => '<string>',
            'Description' => '<string>',
            'LastReportGenerationTime' => '<string>',
            'LastRunFailureReason' => '<string>',
            'LastRunStatus' => '<string>',
            'LicenseManagerReportGeneratorArn' => '<string>',
            'ReportContext' => [
                'licenseConfigurationArns' => ['<string>', ...],
            ],
            'ReportCreatorAccount' => '<string>',
            'ReportFrequency' => [
                'period' => 'DAY|WEEK|MONTH',
                'value' => <integer>,
            ],
            'ReportGeneratorName' => '<string>',
            'ReportType' => ['<string>', ...],
            'S3Location' => [
                'bucket' => '<string>',
                'keyPrefix' => '<string>',
            ],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

Token for the next set of results.

ReportGenerators
  • Type: Array of ReportGenerator structures

A report generator that creates periodic reports about your license configurations.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • AccessDeniedException:

    Access to resource denied.

  • ResourceNotFoundException:

    The resource cannot be found.

ListLicenseSpecificationsForResource

$result = $client->listLicenseSpecificationsForResource([/* ... */]);
$promise = $client->listLicenseSpecificationsForResourceAsync([/* ... */]);

Describes the license configurations for the specified resource.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

ResourceArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of a resource that has an associated license configuration.

Result Syntax

[
    'LicenseSpecifications' => [
        [
            'AmiAssociationScope' => '<string>',
            'LicenseConfigurationArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
LicenseSpecifications
  • Type: Array of LicenseSpecification structures

License configurations associated with a resource.

NextToken
  • Type: string

Token for the next set of results.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

ListLicenseVersions

$result = $client->listLicenseVersions([/* ... */]);
$promise = $client->listLicenseVersionsAsync([/* ... */]);

Lists all versions of the specified license.

Parameter Syntax

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

Parameter Details

Members
LicenseArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license.

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'Licenses' => [
        [
            'Beneficiary' => '<string>',
            'ConsumptionConfiguration' => [
                'BorrowConfiguration' => [
                    'AllowEarlyCheckIn' => true || false,
                    'MaxTimeToLiveInMinutes' => <integer>,
                ],
                'ProvisionalConfiguration' => [
                    'MaxTimeToLiveInMinutes' => <integer>,
                ],
                'RenewType' => 'None|Weekly|Monthly',
            ],
            'CreateTime' => '<string>',
            'Entitlements' => [
                [
                    'AllowCheckIn' => true || false,
                    'MaxCount' => <integer>,
                    'Name' => '<string>',
                    'Overage' => true || false,
                    'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'HomeRegion' => '<string>',
            'Issuer' => [
                'KeyFingerprint' => '<string>',
                'Name' => '<string>',
                'SignKey' => '<string>',
            ],
            'LicenseArn' => '<string>',
            'LicenseMetadata' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'LicenseName' => '<string>',
            'ProductName' => '<string>',
            'ProductSKU' => '<string>',
            'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
            'Validity' => [
                'Begin' => '<string>',
                'End' => '<string>',
            ],
            'Version' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Licenses
  • Type: Array of License structures

License details.

NextToken
  • Type: string

Token for the next set of results.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ServerInternalException:

    The server experienced an internal error. Try again.

ListLicenses

$result = $client->listLicenses([/* ... */]);
$promise = $client->listLicensesAsync([/* ... */]);

Lists the licenses for your account.

Parameter Syntax

$result = $client->listLicenses([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'LicenseArns' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of Filter structures

Filters to scope the results. The following filters are supported:

  • Beneficiary

  • ProductSKU

  • Fingerprint

  • Status

LicenseArns
  • Type: Array of strings

Amazon Resource Names (ARNs) of the licenses.

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'Licenses' => [
        [
            'Beneficiary' => '<string>',
            'ConsumptionConfiguration' => [
                'BorrowConfiguration' => [
                    'AllowEarlyCheckIn' => true || false,
                    'MaxTimeToLiveInMinutes' => <integer>,
                ],
                'ProvisionalConfiguration' => [
                    'MaxTimeToLiveInMinutes' => <integer>,
                ],
                'RenewType' => 'None|Weekly|Monthly',
            ],
            'CreateTime' => '<string>',
            'Entitlements' => [
                [
                    'AllowCheckIn' => true || false,
                    'MaxCount' => <integer>,
                    'Name' => '<string>',
                    'Overage' => true || false,
                    'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'HomeRegion' => '<string>',
            'Issuer' => [
                'KeyFingerprint' => '<string>',
                'Name' => '<string>',
                'SignKey' => '<string>',
            ],
            'LicenseArn' => '<string>',
            'LicenseMetadata' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'LicenseName' => '<string>',
            'ProductName' => '<string>',
            'ProductSKU' => '<string>',
            'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
            'Validity' => [
                'Begin' => '<string>',
                'End' => '<string>',
            ],
            'Version' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Licenses
  • Type: Array of License structures

License details.

NextToken
  • Type: string

Token for the next set of results.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ServerInternalException:

    The server experienced an internal error. Try again.

ListReceivedGrants

$result = $client->listReceivedGrants([/* ... */]);
$promise = $client->listReceivedGrantsAsync([/* ... */]);

Lists grants that are received but not accepted.

Parameter Syntax

$result = $client->listReceivedGrants([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'GrantArns' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of Filter structures

Filters to scope the results. The following filters are supported:

  • ProductSKU

  • LicenseIssuerName

  • LicenseArn

  • GrantStatus

  • GranterAccountId

GrantArns
  • Type: Array of strings

Amazon Resource Names (ARNs) of the grants.

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'Grants' => [
        [
            'GrantArn' => '<string>',
            'GrantName' => '<string>',
            'GrantStatus' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
            'GrantedOperations' => ['<string>', ...],
            'GranteePrincipalArn' => '<string>',
            'HomeRegion' => '<string>',
            'LicenseArn' => '<string>',
            'ParentArn' => '<string>',
            'StatusReason' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Grants
  • Type: Array of Grant structures

Received grant details.

NextToken
  • Type: string

Token for the next set of results.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

ListReceivedGrantsForOrganization

$result = $client->listReceivedGrantsForOrganization([/* ... */]);
$promise = $client->listReceivedGrantsForOrganizationAsync([/* ... */]);

Lists the grants received for all accounts in the organization.

Parameter Syntax

$result = $client->listReceivedGrantsForOrganization([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'LicenseArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of Filter structures

Filters to scope the results. The following filters are supported:

  • ParentArn

  • GranteePrincipalArn

LicenseArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the received license.

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'Grants' => [
        [
            'GrantArn' => '<string>',
            'GrantName' => '<string>',
            'GrantStatus' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
            'GrantedOperations' => ['<string>', ...],
            'GranteePrincipalArn' => '<string>',
            'HomeRegion' => '<string>',
            'LicenseArn' => '<string>',
            'ParentArn' => '<string>',
            'StatusReason' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Grants
  • Type: Array of Grant structures

Lists the grants the organization has received.

NextToken
  • Type: string

Token for the next set of results.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

ListReceivedLicenses

$result = $client->listReceivedLicenses([/* ... */]);
$promise = $client->listReceivedLicensesAsync([/* ... */]);

Lists received licenses.

Parameter Syntax

$result = $client->listReceivedLicenses([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'LicenseArns' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of Filter structures

Filters to scope the results. The following filters are supported:

  • ProductSKU

  • Status

  • Fingerprint

  • IssuerName

  • Beneficiary

LicenseArns
  • Type: Array of strings

Amazon Resource Names (ARNs) of the licenses.

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'Licenses' => [
        [
            'Beneficiary' => '<string>',
            'ConsumptionConfiguration' => [
                'BorrowConfiguration' => [
                    'AllowEarlyCheckIn' => true || false,
                    'MaxTimeToLiveInMinutes' => <integer>,
                ],
                'ProvisionalConfiguration' => [
                    'MaxTimeToLiveInMinutes' => <integer>,
                ],
                'RenewType' => 'None|Weekly|Monthly',
            ],
            'CreateTime' => '<string>',
            'Entitlements' => [
                [
                    'AllowCheckIn' => true || false,
                    'MaxCount' => <integer>,
                    'Name' => '<string>',
                    'Overage' => true || false,
                    'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'HomeRegion' => '<string>',
            'Issuer' => [
                'KeyFingerprint' => '<string>',
                'Name' => '<string>',
                'SignKey' => '<string>',
            ],
            'LicenseArn' => '<string>',
            'LicenseMetadata' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'LicenseName' => '<string>',
            'ProductName' => '<string>',
            'ProductSKU' => '<string>',
            'ReceivedMetadata' => [
                'AllowedOperations' => ['<string>', ...],
                'ReceivedStatus' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|DISABLED|WORKFLOW_COMPLETED',
                'ReceivedStatusReason' => '<string>',
            ],
            'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
            'Validity' => [
                'Begin' => '<string>',
                'End' => '<string>',
            ],
            'Version' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Licenses
  • Type: Array of GrantedLicense structures

Received license details.

NextToken
  • Type: string

Token for the next set of results.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

ListReceivedLicensesForOrganization

$result = $client->listReceivedLicensesForOrganization([/* ... */]);
$promise = $client->listReceivedLicensesForOrganizationAsync([/* ... */]);

Lists the licenses received for all accounts in the organization.

Parameter Syntax

$result = $client->listReceivedLicensesForOrganization([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of Filter structures

Filters to scope the results. The following filters are supported:

  • Beneficiary

  • ProductSKU

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'Licenses' => [
        [
            'Beneficiary' => '<string>',
            'ConsumptionConfiguration' => [
                'BorrowConfiguration' => [
                    'AllowEarlyCheckIn' => true || false,
                    'MaxTimeToLiveInMinutes' => <integer>,
                ],
                'ProvisionalConfiguration' => [
                    'MaxTimeToLiveInMinutes' => <integer>,
                ],
                'RenewType' => 'None|Weekly|Monthly',
            ],
            'CreateTime' => '<string>',
            'Entitlements' => [
                [
                    'AllowCheckIn' => true || false,
                    'MaxCount' => <integer>,
                    'Name' => '<string>',
                    'Overage' => true || false,
                    'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'HomeRegion' => '<string>',
            'Issuer' => [
                'KeyFingerprint' => '<string>',
                'Name' => '<string>',
                'SignKey' => '<string>',
            ],
            'LicenseArn' => '<string>',
            'LicenseMetadata' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'LicenseName' => '<string>',
            'ProductName' => '<string>',
            'ProductSKU' => '<string>',
            'ReceivedMetadata' => [
                'AllowedOperations' => ['<string>', ...],
                'ReceivedStatus' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|DISABLED|WORKFLOW_COMPLETED',
                'ReceivedStatusReason' => '<string>',
            ],
            'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
            'Validity' => [
                'Begin' => '<string>',
                'End' => '<string>',
            ],
            'Version' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Licenses
  • Type: Array of GrantedLicense structures

Lists the licenses the organization has received.

NextToken
  • Type: string

Token for the next set of results.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

ListResourceInventory

$result = $client->listResourceInventory([/* ... */]);
$promise = $client->listResourceInventoryAsync([/* ... */]);

Lists resources managed using Systems Manager inventory.

Parameter Syntax

$result = $client->listResourceInventory([
    'Filters' => [
        [
            'Condition' => 'EQUALS|NOT_EQUALS|BEGINS_WITH|CONTAINS', // REQUIRED
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of InventoryFilter structures

Filters to scope the results. The following filters and logical operators are supported:

  • account_id - The ID of the Amazon Web Services account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.

  • application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH.

  • license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS. Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

  • platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH.

  • resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Logical operators are EQUALS (single account) or EQUALS | NOT_EQUALS (cross account).

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceInventoryList' => [
        [
            'Platform' => '<string>',
            'PlatformVersion' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceId' => '<string>',
            'ResourceOwningAccountId' => '<string>',
            'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

Token for the next set of results.

ResourceInventoryList
  • Type: Array of ResourceInventory structures

Information about the resources.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • FilterLimitExceededException:

    The request uses too many filters or too many filter values.

  • FailedDependencyException:

    A dependency required to run the API is missing.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

ListTagsForResource

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

Lists the tags for the specified license configuration.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license configuration.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Tags
  • Type: Array of Tag structures

Information about the tags.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

ListTokens

$result = $client->listTokens([/* ... */]);
$promise = $client->listTokensAsync([/* ... */]);

Lists your tokens.

Parameter Syntax

$result = $client->listTokens([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TokenIds' => ['<string>', ...],
]);

Parameter Details

Members
Filters
  • Type: Array of Filter structures

Filters to scope the results. The following filter is supported:

  • LicenseArns

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

TokenIds
  • Type: Array of strings

Token IDs.

Result Syntax

[
    'NextToken' => '<string>',
    'Tokens' => [
        [
            'ExpirationTime' => '<string>',
            'LicenseArn' => '<string>',
            'RoleArns' => ['<string>', ...],
            'Status' => '<string>',
            'TokenId' => '<string>',
            'TokenProperties' => ['<string>', ...],
            'TokenType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

Token for the next set of results.

Tokens
  • Type: Array of TokenData structures

Received token details.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ServerInternalException:

    The server experienced an internal error. Try again.

ListUsageForLicenseConfiguration

$result = $client->listUsageForLicenseConfiguration([/* ... */]);
$promise = $client->listUsageForLicenseConfigurationAsync([/* ... */]);

Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.

Parameter Syntax

$result = $client->listUsageForLicenseConfiguration([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'LicenseConfigurationArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of Filter structures

Filters to scope the results. The following filters and logical operators are supported:

  • resourceArn - The ARN of the license configuration resource. Logical operators are EQUALS | NOT_EQUALS.

  • resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS | NOT_EQUALS.

  • resourceAccount - The ID of the account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.

LicenseConfigurationArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license configuration.

MaxResults
  • Type: int

Maximum number of results to return in a single call.

NextToken
  • Type: string

Token for the next set of results.

Result Syntax

[
    'LicenseConfigurationUsageList' => [
        [
            'AssociationTime' => <DateTime>,
            'ConsumedLicenses' => <integer>,
            'ResourceArn' => '<string>',
            'ResourceOwnerId' => '<string>',
            'ResourceStatus' => '<string>',
            'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
LicenseConfigurationUsageList
  • Type: Array of LicenseConfigurationUsage structures

Information about the license configurations.

NextToken
  • Type: string

Token for the next set of results.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • FilterLimitExceededException:

    The request uses too many filters or too many filter values.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

RejectGrant

$result = $client->rejectGrant([/* ... */]);
$promise = $client->rejectGrantAsync([/* ... */]);

Rejects the specified grant.

Parameter Syntax

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

Parameter Details

Members
GrantArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the grant.

Result Syntax

[
    'GrantArn' => '<string>',
    'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
    'Version' => '<string>',
]

Result Details

Members
GrantArn
  • Type: string

Grant ARN.

Status
  • Type: string

Grant status.

Version
  • Type: string

Grant version.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

  • ServerInternalException:

    The server experienced an internal error. Try again.

TagResource

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

Adds the specified tags to the specified license configuration.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license configuration.

Tags
  • Required: Yes
  • Type: Array of Tag structures

One or more tags.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

UntagResource

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

Removes the specified tags from the specified license configuration.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license configuration.

TagKeys
  • Required: Yes
  • Type: Array of strings

Keys identifying the tags to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

UpdateLicenseConfiguration

$result = $client->updateLicenseConfiguration([/* ... */]);
$promise = $client->updateLicenseConfigurationAsync([/* ... */]);

Modifies the attributes of an existing license configuration.

Parameter Syntax

$result = $client->updateLicenseConfiguration([
    'Description' => '<string>',
    'DisassociateWhenNotFound' => true || false,
    'LicenseConfigurationArn' => '<string>', // REQUIRED
    'LicenseConfigurationStatus' => 'AVAILABLE|DISABLED',
    'LicenseCount' => <integer>,
    'LicenseCountHardLimit' => true || false,
    'LicenseRules' => ['<string>', ...],
    'Name' => '<string>',
    'ProductInformationList' => [
        [
            'ProductInformationFilterList' => [ // REQUIRED
                [
                    'ProductInformationFilterComparator' => '<string>', // REQUIRED
                    'ProductInformationFilterName' => '<string>', // REQUIRED
                    'ProductInformationFilterValue' => ['<string>', ...],
                ],
                // ...
            ],
            'ResourceType' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
Description
  • Type: string

New description of the license configuration.

DisassociateWhenNotFound
  • Type: boolean

When true, disassociates a resource when software is uninstalled.

LicenseConfigurationArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license configuration.

LicenseConfigurationStatus
  • Type: string

New status of the license configuration.

LicenseCount
  • Type: long (int|float)

New number of licenses managed by the license configuration.

LicenseCountHardLimit
  • Type: boolean

New hard limit of the number of available licenses.

LicenseRules
  • Type: Array of strings

New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost.

Name
  • Type: string

New name of the license configuration.

ProductInformationList
  • Type: Array of ProductInformation structures

New product information.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

UpdateLicenseManagerReportGenerator

$result = $client->updateLicenseManagerReportGenerator([/* ... */]);
$promise = $client->updateLicenseManagerReportGeneratorAsync([/* ... */]);

Updates a report generator.

After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.

Parameter Syntax

$result = $client->updateLicenseManagerReportGenerator([
    'ClientToken' => '<string>', // REQUIRED
    'Description' => '<string>',
    'LicenseManagerReportGeneratorArn' => '<string>', // REQUIRED
    'ReportContext' => [ // REQUIRED
        'licenseConfigurationArns' => ['<string>', ...], // REQUIRED
    ],
    'ReportFrequency' => [ // REQUIRED
        'period' => 'DAY|WEEK|MONTH',
        'value' => <integer>,
    ],
    'ReportGeneratorName' => '<string>', // REQUIRED
    'Type' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ClientToken
  • Required: Yes
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Description
  • Type: string

Description of the report generator.

LicenseManagerReportGeneratorArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the report generator to update.

ReportContext
  • Required: Yes
  • Type: ReportContext structure

The report context.

ReportFrequency
  • Required: Yes
  • Type: ReportFrequency structure

Frequency by which reports are generated.

ReportGeneratorName
  • Required: Yes
  • Type: string

Name of the report generator.

Type
  • Required: Yes
  • Type: Array of strings

Type of reports to generate. The following report types are supported:

  • License configuration report - Reports the number and details of consumed licenses for a license configuration.

  • Resource report - Reports the tracked licenses and resource consumption for a license configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The provided input is not valid. Try your request again.

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • ResourceNotFoundException:

    The resource cannot be found.

  • ResourceLimitExceededException:

    Your resource limits have been exceeded.

UpdateLicenseSpecificationsForResource

$result = $client->updateLicenseSpecificationsForResource([/* ... */]);
$promise = $client->updateLicenseSpecificationsForResourceAsync([/* ... */]);

Adds or removes the specified license configurations for the specified Amazon Web Services resource.

You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and CloudFormation templates, as they send license configurations to the operation that creates the resource.

Parameter Syntax

$result = $client->updateLicenseSpecificationsForResource([
    'AddLicenseSpecifications' => [
        [
            'AmiAssociationScope' => '<string>',
            'LicenseConfigurationArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'RemoveLicenseSpecifications' => [
        [
            'AmiAssociationScope' => '<string>',
            'LicenseConfigurationArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
AddLicenseSpecifications
  • Type: Array of LicenseSpecification structures

ARNs of the license configurations to add.

RemoveLicenseSpecifications
  • Type: Array of LicenseSpecification structures

ARNs of the license configurations to remove.

ResourceArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the Amazon Web Services resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • InvalidResourceStateException:

    License Manager cannot allocate a license to a resource because of its state.

    For example, you cannot allocate a license to an instance in the process of shutting down.

  • LicenseUsageException:

    You do not have enough licenses available to support a new resource launch.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

UpdateServiceSettings

$result = $client->updateServiceSettings([/* ... */]);
$promise = $client->updateServiceSettingsAsync([/* ... */]);

Updates License Manager settings for the current Region.

Parameter Syntax

$result = $client->updateServiceSettings([
    'EnableCrossAccountsDiscovery' => true || false,
    'OrganizationConfiguration' => [
        'EnableIntegration' => true || false, // REQUIRED
    ],
    'S3BucketArn' => '<string>',
    'SnsTopicArn' => '<string>',
]);

Parameter Details

Members
EnableCrossAccountsDiscovery
  • Type: boolean

Activates cross-account discovery.

OrganizationConfiguration
  • Type: OrganizationConfiguration structure

Enables integration with Organizations for cross-account discovery.

S3BucketArn
  • Type: string

Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.

SnsTopicArn
  • Type: string

Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterValueException:

    One or more parameter values are not valid.

  • ServerInternalException:

    The server experienced an internal error. Try again.

  • AuthorizationException:

    The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

  • AccessDeniedException:

    Access to resource denied.

  • RateLimitExceededException:

    Too many requests have been submitted. Try again after a brief wait.

Shapes

AccessDeniedException

Description

Access to resource denied.

Members
Message
  • Type: string

AuthorizationException

Description

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

Members
Message
  • Type: string

AutomatedDiscoveryInformation

Description

Describes automated discovery.

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

Time that automated discovery last ran.

BorrowConfiguration

Description

Details about a borrow configuration.

Members
AllowEarlyCheckIn
  • Required: Yes
  • Type: boolean

Indicates whether early check-ins are allowed.

MaxTimeToLiveInMinutes
  • Required: Yes
  • Type: int

Maximum time for the borrow configuration, in minutes.

ConflictException

Description

There was a conflict processing the request. Try your request again.

Members
Message
  • Type: string

ConsumedLicenseSummary

Description

Details about license consumption.

Members
ConsumedLicenses
  • Type: long (int|float)

Number of licenses consumed by the resource.

ResourceType
  • Type: string

Resource type of the resource consuming a license.

ConsumptionConfiguration

Description

Details about a consumption configuration.

Members
BorrowConfiguration
  • Type: BorrowConfiguration structure

Details about a borrow configuration.

ProvisionalConfiguration
  • Type: ProvisionalConfiguration structure

Details about a provisional configuration.

RenewType
  • Type: string

Renewal frequency.

DatetimeRange

Description

Describes a time range, in ISO8601-UTC format.

Members
Begin
  • Required: Yes
  • Type: string

Start of the time range.

End
  • Type: string

End of the time range.

Entitlement

Description

Describes a resource entitled for use with a license.

Members
AllowCheckIn
  • Type: boolean

Indicates whether check-ins are allowed.

MaxCount
  • Type: long (int|float)

Maximum entitlement count. Use if the unit is not None.

Name
  • Required: Yes
  • Type: string

Entitlement name.

Overage
  • Type: boolean

Indicates whether overages are allowed.

Unit
  • Required: Yes
  • Type: string

Entitlement unit.

Value
  • Type: string

Entitlement resource. Use only if the unit is None.

EntitlementData

Description

Data associated with an entitlement resource.

Members
Name
  • Required: Yes
  • Type: string

Entitlement data name.

Unit
  • Required: Yes
  • Type: string

Entitlement data unit.

Value
  • Type: string

Entitlement data value.

EntitlementNotAllowedException

Description

The entitlement is not allowed.

Members
Message
  • Type: string

EntitlementUsage

Description

Usage associated with an entitlement resource.

Members
ConsumedValue
  • Required: Yes
  • Type: string

Resource usage consumed.

MaxCount
  • Type: string

Maximum entitlement usage count.

Name
  • Required: Yes
  • Type: string

Entitlement usage name.

Unit
  • Required: Yes
  • Type: string

Entitlement usage unit.

FailedDependencyException

Description

A dependency required to run the API is missing.

Members
ErrorCode
  • Type: string
Message
  • Type: string

Filter

Description

A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

Members
Name
  • Type: string

Name of the filter. Filter names are case-sensitive.

Values
  • Type: Array of strings

Filter values. Filter values are case-sensitive.

FilterLimitExceededException

Description

The request uses too many filters or too many filter values.

Members
Message
  • Type: string

Grant

Description

Describes a grant.

Members
GrantArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the grant.

GrantName
  • Required: Yes
  • Type: string

Grant name.

GrantStatus
  • Required: Yes
  • Type: string

Grant status.

GrantedOperations
  • Required: Yes
  • Type: Array of strings

Granted operations.

GranteePrincipalArn
  • Required: Yes
  • Type: string

The grantee principal ARN.

HomeRegion
  • Required: Yes
  • Type: string

Home Region of the grant.

LicenseArn
  • Required: Yes
  • Type: string

License ARN.

ParentArn
  • Required: Yes
  • Type: string

Parent ARN.

StatusReason
  • Type: string

Grant status reason.

Version
  • Required: Yes
  • Type: string

Grant version.

GrantedLicense

Description

Describes a license that is granted to a grantee.

Members
Beneficiary
  • Type: string

Granted license beneficiary.

ConsumptionConfiguration
  • Type: ConsumptionConfiguration structure

Configuration for consumption of the license.

CreateTime
  • Type: string

Creation time of the granted license.

Entitlements
  • Type: Array of Entitlement structures

License entitlements.

HomeRegion
  • Type: string

Home Region of the granted license.

Issuer
  • Type: IssuerDetails structure

Granted license issuer.

LicenseArn
  • Type: string

Amazon Resource Name (ARN) of the license.

LicenseMetadata
  • Type: Array of Metadata structures

Granted license metadata.

LicenseName
  • Type: string

License name.

ProductName
  • Type: string

Product name.

ProductSKU
  • Type: string

Product SKU.

ReceivedMetadata
  • Type: ReceivedMetadata structure

Granted license received metadata.

Status
  • Type: string

Granted license status.

Validity
  • Type: DatetimeRange structure

Date and time range during which the granted license is valid, in ISO8601-UTC format.

Version
  • Type: string

Version of the granted license.

InvalidParameterValueException

Description

One or more parameter values are not valid.

Members
Message
  • Type: string

InvalidResourceStateException

Description

License Manager cannot allocate a license to a resource because of its state.

For example, you cannot allocate a license to an instance in the process of shutting down.

Members
Message
  • Type: string

InventoryFilter

Description

An inventory filter.

Members
Condition
  • Required: Yes
  • Type: string

Condition of the filter.

Name
  • Required: Yes
  • Type: string

Name of the filter.

Value
  • Type: string

Value of the filter.

Issuer

Description

Details about the issuer of a license.

Members
Name
  • Required: Yes
  • Type: string

Issuer name.

SignKey
  • Type: string

Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

IssuerDetails

Description

Details associated with the issuer of a license.

Members
KeyFingerprint
  • Type: string

Issuer key fingerprint.

Name
  • Type: string

Issuer name.

SignKey
  • Type: string

Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

License

Description

Software license that is managed in License Manager.

Members
Beneficiary
  • Type: string

License beneficiary.

ConsumptionConfiguration
  • Type: ConsumptionConfiguration structure

Configuration for consumption of the license.

CreateTime
  • Type: string

License creation time.

Entitlements
  • Type: Array of Entitlement structures

License entitlements.

HomeRegion
  • Type: string

Home Region of the license.

Issuer
  • Type: IssuerDetails structure

License issuer.

LicenseArn
  • Type: string

Amazon Resource Name (ARN) of the license.

LicenseMetadata
  • Type: Array of Metadata structures

License metadata.

LicenseName
  • Type: string

License name.

ProductName
  • Type: string

Product name.

ProductSKU
  • Type: string

Product SKU.

Status
  • Type: string

License status.

Validity
  • Type: DatetimeRange structure

Date and time range during which the license is valid, in ISO8601-UTC format.

Version
  • Type: string

License version.

LicenseConfiguration

Description

A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), host affinity (how long a VM must be associated with a host), and the number of licenses purchased and used.

Members
AutomatedDiscoveryInformation
  • Type: AutomatedDiscoveryInformation structure

Automated discovery information.

ConsumedLicenseSummaryList
  • Type: Array of ConsumedLicenseSummary structures

Summaries for licenses consumed by various resources.

ConsumedLicenses
  • Type: long (int|float)

Number of licenses consumed.

Description
  • Type: string

Description of the license configuration.

DisassociateWhenNotFound
  • Type: boolean

When true, disassociates a resource when software is uninstalled.

LicenseConfigurationArn
  • Type: string

Amazon Resource Name (ARN) of the license configuration.

LicenseConfigurationId
  • Type: string

Unique ID of the license configuration.

LicenseCount
  • Type: long (int|float)

Number of licenses managed by the license configuration.

LicenseCountHardLimit
  • Type: boolean

Number of available licenses as a hard limit.

LicenseCountingType
  • Type: string

Dimension to use to track the license inventory.

LicenseRules
  • Type: Array of strings

License rules.

ManagedResourceSummaryList
  • Type: Array of ManagedResourceSummary structures

Summaries for managed resources.

Name
  • Type: string

Name of the license configuration.

OwnerAccountId
  • Type: string

Account ID of the license configuration's owner.

ProductInformationList
  • Type: Array of ProductInformation structures

Product information.

Status
  • Type: string

Status of the license configuration.

LicenseConfigurationAssociation

Description

Describes an association with a license configuration.

Members
AmiAssociationScope
  • Type: string

Scope of AMI associations. The possible value is cross-account.

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

Time when the license configuration was associated with the resource.

ResourceArn
  • Type: string

Amazon Resource Name (ARN) of the resource.

ResourceOwnerId
  • Type: string

ID of the Amazon Web Services account that owns the resource consuming licenses.

ResourceType
  • Type: string

Type of server resource.

LicenseConfigurationUsage

Description

Details about the usage of a resource associated with a license configuration.

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

Time when the license configuration was initially associated with the resource.

ConsumedLicenses
  • Type: long (int|float)

Number of licenses consumed by the resource.

ResourceArn
  • Type: string

Amazon Resource Name (ARN) of the resource.

ResourceOwnerId
  • Type: string

ID of the account that owns the resource.

ResourceStatus
  • Type: string

Status of the resource.

ResourceType
  • Type: string

Type of resource.

LicenseConversionContext

Description

Information about a license type conversion task.

Members
UsageOperation
  • Type: string

The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform

LicenseConversionTask

Description

Information about a license type conversion task.

Members
DestinationLicenseContext
  • Type: LicenseConversionContext structure

Information about the license type this conversion task converted to.

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

The time the conversion task was completed.

LicenseConversionTaskId
  • Type: string

The ID of the license type conversion task.

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

The time the usage operation value of the resource was changed.

ResourceArn
  • Type: string

The Amazon Resource Name (ARN) of the resource associated with the license type conversion task.

SourceLicenseContext
  • Type: LicenseConversionContext structure

Information about the license type this conversion task converted from.

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

The time the conversion task was started at.

Status
  • Type: string

The status of the conversion task.

StatusMessage
  • Type: string

The status message for the conversion task.

LicenseOperationFailure

Description

Describes the failure of a license operation.

Members
ErrorMessage
  • Type: string

Error message.

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

Failure time.

MetadataList
  • Type: Array of Metadata structures

Reserved.

OperationName
  • Type: string

Name of the operation.

OperationRequestedBy
  • Type: string

The requester is "License Manager Automated Discovery".

ResourceArn
  • Type: string

Amazon Resource Name (ARN) of the resource.

ResourceOwnerId
  • Type: string

ID of the Amazon Web Services account that owns the resource.

ResourceType
  • Type: string

Resource type.

LicenseSpecification

Description

Details for associating a license configuration with a resource.

Members
AmiAssociationScope
  • Type: string

Scope of AMI associations. The possible value is cross-account.

LicenseConfigurationArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the license configuration.

LicenseUsage

Description

Describes the entitlement usage associated with a license.

Members
EntitlementUsages
  • Type: Array of EntitlementUsage structures

License entitlement usages.

LicenseUsageException

Description

You do not have enough licenses available to support a new resource launch.

Members
Message
  • Type: string

ManagedResourceSummary

Description

Summary information about a managed resource.

Members
AssociationCount
  • Type: long (int|float)

Number of resources associated with licenses.

ResourceType
  • Type: string

Type of resource associated with a license.

Metadata

Description

Describes key/value pairs.

Members
Name
  • Type: string

The key name.

Value
  • Type: string

The value.

NoEntitlementsAllowedException

Description

There are no entitlements found for this license, or the entitlement maximum count is reached.

Members
Message
  • Type: string

OrganizationConfiguration

Description

Configuration information for Organizations.

Members
EnableIntegration
  • Required: Yes
  • Type: boolean

Enables Organizations integration.

ProductInformation

Description

Describes product information for a license configuration.

Members
ProductInformationFilterList
  • Required: Yes
  • Type: Array of ProductInformationFilter structures

A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.

The following filters and are supported when the resource type is SSM_MANAGED:

  • Application Name - The name of the application. Logical operator is EQUALS.

  • Application Publisher - The publisher of the application. Logical operator is EQUALS.

  • Application Version - The version of the application. Logical operator is EQUALS.

  • Platform Name - The name of the platform. Logical operator is EQUALS.

  • Platform Type - The platform type. Logical operator is EQUALS.

  • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.

  • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.

  • License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

The following filters and logical operators are supported when the resource type is RDS:

  • Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2.

  • License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.

ResourceType
  • Required: Yes
  • Type: string

Resource type. The possible values are SSM_MANAGED | RDS.

ProductInformationFilter

Description

Describes product information filters.

Members
ProductInformationFilterComparator
  • Required: Yes
  • Type: string

Logical operator.

ProductInformationFilterName
  • Required: Yes
  • Type: string

Filter name.

ProductInformationFilterValue
  • Type: Array of strings

Filter value.

ProvisionalConfiguration

Description

Details about a provisional configuration.

Members
MaxTimeToLiveInMinutes
  • Required: Yes
  • Type: int

Maximum time for the provisional configuration, in minutes.

RateLimitExceededException

Description

Too many requests have been submitted. Try again after a brief wait.

Members
Message
  • Type: string

ReceivedMetadata

Description

Metadata associated with received licenses and grants.

Members
AllowedOperations
  • Type: Array of strings

Allowed operations.

ReceivedStatus
  • Type: string

Received status.

ReceivedStatusReason
  • Type: string

Received status reason.

RedirectException

Description

This is not the correct Region for the resource. Try again.

Members
Location
  • Type: string
Message
  • Type: string

ReportContext

Description

Details of the license configuration that this generator reports on.

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

Amazon Resource Name (ARN) of the license configuration that this generator reports on.

ReportFrequency

Description

Details about how frequently reports are generated.

Members
period
  • Type: string

Time period between each report. The period can be daily, weekly, or monthly.

value
  • Type: int

Number of times within the frequency period that a report is generated. The only supported value is 1.

ReportGenerator

Description

Describe the details of a report generator.

Members
CreateTime
  • Type: string

Time the report was created.

Description
  • Type: string

Description of the report generator.

LastReportGenerationTime
  • Type: string

Time the last report was generated at.

LastRunFailureReason
  • Type: string

Failure message for the last report generation attempt.

LastRunStatus
  • Type: string

Status of the last report generation attempt.

LicenseManagerReportGeneratorArn
  • Type: string

Amazon Resource Name (ARN) of the report generator.

ReportContext
  • Type: ReportContext structure

License configuration type for this generator.

ReportCreatorAccount
  • Type: string

The Amazon Web Services account ID used to create the report generator.

ReportFrequency
  • Type: ReportFrequency structure

Details about how frequently reports are generated.

ReportGeneratorName
  • Type: string

Name of the report generator.

ReportType
  • Type: Array of strings

Type of reports that are generated.

S3Location
  • Type: S3Location structure

Details of the S3 bucket that report generator reports are published to.

Tags
  • Type: Array of Tag structures

Tags associated with the report generator.

ResourceInventory

Description

Details about a resource.

Members
Platform
  • Type: string

Platform of the resource.

PlatformVersion
  • Type: string

Platform version of the resource in the inventory.

ResourceArn
  • Type: string

Amazon Resource Name (ARN) of the resource.

ResourceId
  • Type: string

ID of the resource.

ResourceOwningAccountId
  • Type: string

ID of the account that owns the resource.

ResourceType
  • Type: string

Type of resource.

ResourceLimitExceededException

Description

Your resource limits have been exceeded.

Members
Message
  • Type: string

ResourceNotFoundException

Description

The resource cannot be found.

Members
Message
  • Type: string

S3Location

Description

Details of the S3 bucket that report generator reports are published to.

Members
bucket
  • Type: string

Name of the S3 bucket reports are published to.

keyPrefix
  • Type: string

Prefix of the S3 bucket reports are published to.

ServerInternalException

Description

The server experienced an internal error. Try again.

Members
Message
  • Type: string

Tag

Description

Details about a tag for a license configuration.

Members
Key
  • Type: string

Tag key.

Value
  • Type: string

Tag value.

TokenData

Description

Describes a token.

Members
ExpirationTime
  • Type: string

Token expiration time, in ISO8601-UTC format.

LicenseArn
  • Type: string

Amazon Resource Name (ARN) of the license.

RoleArns
  • Type: Array of strings

Amazon Resource Names (ARN) of the roles included in the token.

Status
  • Type: string

Token status. The possible values are AVAILABLE and DELETED.

TokenId
  • Type: string

Token ID.

TokenProperties
  • Type: Array of strings

Data specified by the caller.

TokenType
  • Type: string

Type of token generated. The supported value is REFRESH_TOKEN.

UnsupportedDigitalSignatureMethodException

Description

The digital signature method is unsupported. Try your request again.

Members
Message
  • Type: string

ValidationException

Description

The provided input is not valid. Try your request again.

Members
Message
  • Type: string
AWS SDK for PHP 3.x API documentation generated by ApiGen