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

Namespaces

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

Classes

  • 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\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\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\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\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\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\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\TranscribeService\Exception\TranscribeServiceException
  • Aws\Transfer\Exception\TransferException
  • Aws\Translate\Exception\TranslateException
  • Aws\VoiceID\Exception\VoiceIDException
  • Aws\Waf\Exception\WafException
  • Aws\WafRegional\Exception\WafRegionalException
  • Aws\WAFV2\Exception\WAFV2Exception
  • Aws\WellArchitected\Exception\WellArchitectedException
  • Aws\WorkDocs\Exception\WorkDocsException
  • Aws\WorkLink\Exception\WorkLinkException
  • Aws\WorkMail\Exception\WorkMailException
  • Aws\WorkMailMessageFlow\Exception\WorkMailMessageFlowException
  • Aws\WorkSpaces\Exception\WorkSpacesException
  • Aws\WorkSpacesWeb\Exception\WorkSpacesWebException
  • Aws\XRay\Exception\XRayException

Functions

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

IAM Roles Anywhere 2018-05-10

Client: Aws\RolesAnywhere\RolesAnywhereClient
Service ID: rolesanywhere
Version: 2018-05-10

This page describes the parameters and results for the operations of the IAM Roles Anywhere (2018-05-10), and shows how to use the Aws\RolesAnywhere\RolesAnywhereClient object to call the described operations. This documentation is specific to the 2018-05-10 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 */).

  • CreateProfile ( array $params = [] )

    Creates a profile.

  • CreateTrustAnchor ( array $params = [] )

    Creates a trust anchor.

  • DeleteCrl ( array $params = [] )

    Deletes a certificate revocation list (CRL).

  • DeleteProfile ( array $params = [] )

    Deletes a profile.

  • DeleteTrustAnchor ( array $params = [] )

    Deletes a trust anchor.

  • DisableCrl ( array $params = [] )

    Disables a certificate revocation list (CRL).

  • DisableProfile ( array $params = [] )

    Disables a profile.

  • DisableTrustAnchor ( array $params = [] )

    Disables a trust anchor.

  • EnableCrl ( array $params = [] )

    Enables a certificate revocation list (CRL).

  • EnableProfile ( array $params = [] )

    Enables the roles in a profile to receive session credentials in CreateSession.

  • EnableTrustAnchor ( array $params = [] )

    Enables a trust anchor.

  • GetCrl ( array $params = [] )

    Gets a certificate revocation list (CRL).

  • GetProfile ( array $params = [] )

    Gets a profile.

  • GetSubject ( array $params = [] )

    Gets a Subject.

  • GetTrustAnchor ( array $params = [] )

    Gets a trust anchor.

  • ImportCrl ( array $params = [] )

    Imports the certificate revocation list (CRL).

  • ListCrls ( array $params = [] )

    Lists all Crls in the authenticated account and Amazon Web Services Region.

  • ListProfiles ( array $params = [] )

    Lists all profiles in the authenticated account and Amazon Web Services Region.

  • ListSubjects ( array $params = [] )

    Lists the subjects in the authenticated account and Amazon Web Services Region.

  • ListTagsForResource ( array $params = [] )

    Lists the tags attached to the resource.

  • ListTrustAnchors ( array $params = [] )

    Lists the trust anchors in the authenticated account and Amazon Web Services Region.

  • TagResource ( array $params = [] )

    Attaches tags to a resource.

  • UntagResource ( array $params = [] )

    Removes tags from the resource.

  • UpdateCrl ( array $params = [] )

    Updates the certificate revocation list (CRL).

  • UpdateProfile ( array $params = [] )

    Updates the profile.

  • UpdateTrustAnchor ( array $params = [] )

    Updates the trust anchor.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

  • ListCrls
  • ListProfiles
  • ListSubjects
  • ListTrustAnchors

Operations

CreateProfile

$result = $client->createProfile([/* ... */]);
$promise = $client->createProfileAsync([/* ... */]);

Creates a profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can intersect permissions with IAM managed policies.

Required permissions: rolesanywhere:CreateProfile.

Parameter Syntax

$result = $client->createProfile([
    'durationSeconds' => <integer>,
    'enabled' => true || false,
    'managedPolicyArns' => ['<string>', ...],
    'name' => '<string>', // REQUIRED
    'requireInstanceProperties' => true || false,
    'roleArns' => ['<string>', ...], // REQUIRED
    'sessionPolicy' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
durationSeconds
  • Type: int

The number of seconds the vended session credentials are valid for.

enabled
  • Type: boolean

Specifies whether the profile is enabled.

managedPolicyArns
  • Type: Array of strings

A list of managed policy ARNs that apply to the vended session credentials.

name
  • Required: Yes
  • Type: string

The name of the profile.

requireInstanceProperties
  • Type: boolean

Specifies whether instance properties are required in CreateSession requests with this profile.

roleArns
  • Required: Yes
  • Type: Array of strings

A list of IAM roles that this profile can assume in a CreateSession operation.

sessionPolicy
  • Type: string

A session policy that applies to the trust boundary of the vended session credentials.

tags
  • Type: Array of Tag structures

The tags to attach to the profile.

Result Syntax

[
    'profile' => [
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
profile
  • Type: ProfileDetail structure

The state of the profile after a read or write operation.

Errors

  • ValidationException:

    Validation exception error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

CreateTrustAnchor

$result = $client->createTrustAnchor([/* ... */]);
$promise = $client->createTrustAnchorAsync([/* ... */]);

Creates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.

Required permissions: rolesanywhere:CreateTrustAnchor.

Parameter Syntax

$result = $client->createTrustAnchor([
    'enabled' => true || false,
    'name' => '<string>', // REQUIRED
    'source' => [ // REQUIRED
        'sourceData' => [
            'acmPcaArn' => '<string>',
            'x509CertificateData' => '<string>',
        ],
        'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
enabled
  • Type: boolean

Specifies whether the trust anchor is enabled.

name
  • Required: Yes
  • Type: string

The name of the trust anchor.

source
  • Required: Yes
  • Type: Source structure

The trust anchor type and its related certificate data.

tags
  • Type: Array of Tag structures

The tags to attach to the trust anchor.

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
trustAnchor
  • Required: Yes
  • Type: TrustAnchorDetail structure

The state of the trust anchor after a read or write operation.

Errors

  • ValidationException:

    Validation exception error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

DeleteCrl

$result = $client->deleteCrl([/* ... */]);
$promise = $client->deleteCrlAsync([/* ... */]);

Deletes a certificate revocation list (CRL).

Required permissions: rolesanywhere:DeleteCrl.

Parameter Syntax

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

Parameter Details

Members
crlId
  • Required: Yes
  • Type: string

The unique identifier of the certificate revocation list (CRL).

Result Syntax

[
    'crl' => [
        'createdAt' => <DateTime>,
        'crlArn' => '<string>',
        'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
        'crlId' => '<string>',
        'enabled' => true || false,
        'name' => '<string>',
        'trustAnchorArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
crl
  • Required: Yes
  • Type: CrlDetail structure

The state of the certificate revocation list (CRL) after a read or write operation.

Errors

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

DeleteProfile

$result = $client->deleteProfile([/* ... */]);
$promise = $client->deleteProfileAsync([/* ... */]);

Deletes a profile.

Required permissions: rolesanywhere:DeleteProfile.

Parameter Syntax

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

Parameter Details

Members
profileId
  • Required: Yes
  • Type: string

The unique identifier of the profile.

Result Syntax

[
    'profile' => [
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
profile
  • Type: ProfileDetail structure

The state of the profile after a read or write operation.

Errors

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

DeleteTrustAnchor

$result = $client->deleteTrustAnchor([/* ... */]);
$promise = $client->deleteTrustAnchorAsync([/* ... */]);

Deletes a trust anchor.

Required permissions: rolesanywhere:DeleteTrustAnchor.

Parameter Syntax

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

Parameter Details

Members
trustAnchorId
  • Required: Yes
  • Type: string

The unique identifier of the trust anchor.

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
trustAnchor
  • Required: Yes
  • Type: TrustAnchorDetail structure

The state of the trust anchor after a read or write operation.

Errors

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

DisableCrl

$result = $client->disableCrl([/* ... */]);
$promise = $client->disableCrlAsync([/* ... */]);

Disables a certificate revocation list (CRL).

Required permissions: rolesanywhere:DisableCrl.

Parameter Syntax

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

Parameter Details

Members
crlId
  • Required: Yes
  • Type: string

The unique identifier of the certificate revocation list (CRL).

Result Syntax

[
    'crl' => [
        'createdAt' => <DateTime>,
        'crlArn' => '<string>',
        'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
        'crlId' => '<string>',
        'enabled' => true || false,
        'name' => '<string>',
        'trustAnchorArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
crl
  • Required: Yes
  • Type: CrlDetail structure

The state of the certificate revocation list (CRL) after a read or write operation.

Errors

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

DisableProfile

$result = $client->disableProfile([/* ... */]);
$promise = $client->disableProfileAsync([/* ... */]);

Disables a profile. When disabled, CreateSession requests with this profile fail.

Required permissions: rolesanywhere:DisableProfile.

Parameter Syntax

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

Parameter Details

Members
profileId
  • Required: Yes
  • Type: string

The unique identifier of the profile.

Result Syntax

[
    'profile' => [
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
profile
  • Type: ProfileDetail structure

The state of the profile after a read or write operation.

Errors

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

DisableTrustAnchor

$result = $client->disableTrustAnchor([/* ... */]);
$promise = $client->disableTrustAnchorAsync([/* ... */]);

Disables a trust anchor. When disabled, CreateSession requests specifying this trust anchor are unauthorized.

Required permissions: rolesanywhere:DisableTrustAnchor.

Parameter Syntax

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

Parameter Details

Members
trustAnchorId
  • Required: Yes
  • Type: string

The unique identifier of the trust anchor.

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
trustAnchor
  • Required: Yes
  • Type: TrustAnchorDetail structure

The state of the trust anchor after a read or write operation.

Errors

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

EnableCrl

$result = $client->enableCrl([/* ... */]);
$promise = $client->enableCrlAsync([/* ... */]);

Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials.

Required permissions: rolesanywhere:EnableCrl.

Parameter Syntax

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

Parameter Details

Members
crlId
  • Required: Yes
  • Type: string

The unique identifier of the certificate revocation list (CRL).

Result Syntax

[
    'crl' => [
        'createdAt' => <DateTime>,
        'crlArn' => '<string>',
        'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
        'crlId' => '<string>',
        'enabled' => true || false,
        'name' => '<string>',
        'trustAnchorArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
crl
  • Required: Yes
  • Type: CrlDetail structure

The state of the certificate revocation list (CRL) after a read or write operation.

Errors

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

EnableProfile

$result = $client->enableProfile([/* ... */]);
$promise = $client->enableProfileAsync([/* ... */]);

Enables the roles in a profile to receive session credentials in CreateSession.

Required permissions: rolesanywhere:EnableProfile.

Parameter Syntax

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

Parameter Details

Members
profileId
  • Required: Yes
  • Type: string

The unique identifier of the profile.

Result Syntax

[
    'profile' => [
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
profile
  • Type: ProfileDetail structure

The state of the profile after a read or write operation.

Errors

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

EnableTrustAnchor

$result = $client->enableTrustAnchor([/* ... */]);
$promise = $client->enableTrustAnchorAsync([/* ... */]);

Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation.

Required permissions: rolesanywhere:EnableTrustAnchor.

Parameter Syntax

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

Parameter Details

Members
trustAnchorId
  • Required: Yes
  • Type: string

The unique identifier of the trust anchor.

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
trustAnchor
  • Required: Yes
  • Type: TrustAnchorDetail structure

The state of the trust anchor after a read or write operation.

Errors

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

GetCrl

$result = $client->getCrl([/* ... */]);
$promise = $client->getCrlAsync([/* ... */]);

Gets a certificate revocation list (CRL).

Required permissions: rolesanywhere:GetCrl.

Parameter Syntax

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

Parameter Details

Members
crlId
  • Required: Yes
  • Type: string

The unique identifier of the certificate revocation list (CRL).

Result Syntax

[
    'crl' => [
        'createdAt' => <DateTime>,
        'crlArn' => '<string>',
        'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
        'crlId' => '<string>',
        'enabled' => true || false,
        'name' => '<string>',
        'trustAnchorArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
crl
  • Required: Yes
  • Type: CrlDetail structure

The state of the certificate revocation list (CRL) after a read or write operation.

Errors

  • ResourceNotFoundException:

    The resource could not be found.

GetProfile

$result = $client->getProfile([/* ... */]);
$promise = $client->getProfileAsync([/* ... */]);

Gets a profile.

Required permissions: rolesanywhere:GetProfile.

Parameter Syntax

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

Parameter Details

Members
profileId
  • Required: Yes
  • Type: string

The unique identifier of the profile.

Result Syntax

[
    'profile' => [
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
profile
  • Type: ProfileDetail structure

The state of the profile after a read or write operation.

Errors

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

GetSubject

$result = $client->getSubject([/* ... */]);
$promise = $client->getSubjectAsync([/* ... */]);

Gets a Subject. A Subject associates a certificate identity with authentication attempts by CreateSession. The Subject resources stores audit information such as status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication.

Required permissions: rolesanywhere:GetSubject.

Parameter Syntax

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

Parameter Details

Members
subjectId
  • Required: Yes
  • Type: string

The unique identifier of the subject.

Result Syntax

[
    'subject' => [
        'createdAt' => <DateTime>,
        'credentials' => [
            [
                'enabled' => true || false,
                'failed' => true || false,
                'issuer' => '<string>',
                'seenAt' => <DateTime>,
                'serialNumber' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            // ...
        ],
        'enabled' => true || false,
        'instanceProperties' => [
            [
                'failed' => true || false,
                'properties' => ['<string>', ...],
                'seenAt' => <DateTime>,
            ],
            // ...
        ],
        'lastSeenAt' => <DateTime>,
        'subjectArn' => '<string>',
        'subjectId' => '<string>',
        'updatedAt' => <DateTime>,
        'x509Subject' => '<string>',
    ],
]

Result Details

Members
subject
  • Type: SubjectDetail structure

The state of the subject after a read or write operation.

Errors

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

GetTrustAnchor

$result = $client->getTrustAnchor([/* ... */]);
$promise = $client->getTrustAnchorAsync([/* ... */]);

Gets a trust anchor.

Required permissions: rolesanywhere:GetTrustAnchor.

Parameter Syntax

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

Parameter Details

Members
trustAnchorId
  • Required: Yes
  • Type: string

The unique identifier of the trust anchor.

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
trustAnchor
  • Required: Yes
  • Type: TrustAnchorDetail structure

The state of the trust anchor after a read or write operation.

Errors

  • ValidationException:

    Validation exception error.

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ImportCrl

$result = $client->importCrl([/* ... */]);
$promise = $client->importCrlAsync([/* ... */]);

Imports the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials.

Required permissions: rolesanywhere:ImportCrl.

Parameter Syntax

$result = $client->importCrl([
    'crlData' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'enabled' => true || false,
    'name' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'trustAnchorArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
crlData
  • Required: Yes
  • Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The x509 v3 specified certificate revocation list

enabled
  • Type: boolean

Specifies whether the certificate revocation list (CRL) is enabled.

name
  • Required: Yes
  • Type: string

The name of the certificate revocation list (CRL).

tags
  • Type: Array of Tag structures

A list of tags to attach to the certificate revocation list (CRL).

trustAnchorArn
  • Required: Yes
  • Type: string

The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.

Result Syntax

[
    'crl' => [
        'createdAt' => <DateTime>,
        'crlArn' => '<string>',
        'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
        'crlId' => '<string>',
        'enabled' => true || false,
        'name' => '<string>',
        'trustAnchorArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
crl
  • Required: Yes
  • Type: CrlDetail structure

The state of the certificate revocation list (CRL) after a read or write operation.

Errors

  • ValidationException:

    Validation exception error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ListCrls

$result = $client->listCrls([/* ... */]);
$promise = $client->listCrlsAsync([/* ... */]);

Lists all Crls in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListCrls.

Parameter Syntax

$result = $client->listCrls([
    'nextToken' => '<string>',
    'pageSize' => <integer>,
]);

Parameter Details

Members
nextToken
  • Type: string

A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

pageSize
  • Type: int

The number of resources in the paginated list.

Result Syntax

[
    'crls' => [
        [
            'createdAt' => <DateTime>,
            'crlArn' => '<string>',
            'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
            'crlId' => '<string>',
            'enabled' => true || false,
            'name' => '<string>',
            'trustAnchorArn' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
crls
  • Type: Array of CrlDetail structures

A list of certificate revocation lists (CRL).

nextToken
  • Type: string

A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

Errors

  • ValidationException:

    Validation exception error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ListProfiles

$result = $client->listProfiles([/* ... */]);
$promise = $client->listProfilesAsync([/* ... */]);

Lists all profiles in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListProfiles.

Parameter Syntax

$result = $client->listProfiles([
    'nextToken' => '<string>',
    'pageSize' => <integer>,
]);

Parameter Details

Members
nextToken
  • Type: string

A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

pageSize
  • Type: int

The number of resources in the paginated list.

Result Syntax

[
    'nextToken' => '<string>',
    'profiles' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'durationSeconds' => <integer>,
            'enabled' => true || false,
            'managedPolicyArns' => ['<string>', ...],
            'name' => '<string>',
            'profileArn' => '<string>',
            'profileId' => '<string>',
            'requireInstanceProperties' => true || false,
            'roleArns' => ['<string>', ...],
            'sessionPolicy' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

profiles
  • Type: Array of ProfileDetail structures

A list of profiles.

Errors

  • ValidationException:

    Validation exception error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ListSubjects

$result = $client->listSubjects([/* ... */]);
$promise = $client->listSubjectsAsync([/* ... */]);

Lists the subjects in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListSubjects.

Parameter Syntax

$result = $client->listSubjects([
    'nextToken' => '<string>',
    'pageSize' => <integer>,
]);

Parameter Details

Members
nextToken
  • Type: string

A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

pageSize
  • Type: int

The number of resources in the paginated list.

Result Syntax

[
    'nextToken' => '<string>',
    'subjects' => [
        [
            'createdAt' => <DateTime>,
            'enabled' => true || false,
            'lastSeenAt' => <DateTime>,
            'subjectArn' => '<string>',
            'subjectId' => '<string>',
            'updatedAt' => <DateTime>,
            'x509Subject' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

subjects
  • Type: Array of SubjectSummary structures

A list of subjects.

Errors

  • ValidationException:

    Validation exception error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ListTagsForResource

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

Lists the tags attached to the resource.

Required permissions: rolesanywhere:ListTagsForResource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The ARN of the resource.

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
tags
  • Type: Array of Tag structures

A list of tags attached to the resource.

Errors

  • ValidationException:

    Validation exception error.

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ListTrustAnchors

$result = $client->listTrustAnchors([/* ... */]);
$promise = $client->listTrustAnchorsAsync([/* ... */]);

Lists the trust anchors in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListTrustAnchors.

Parameter Syntax

$result = $client->listTrustAnchors([
    'nextToken' => '<string>',
    'pageSize' => <integer>,
]);

Parameter Details

Members
nextToken
  • Type: string

A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

pageSize
  • Type: int

The number of resources in the paginated list.

Result Syntax

[
    'nextToken' => '<string>',
    'trustAnchors' => [
        [
            'createdAt' => <DateTime>,
            'enabled' => true || false,
            'name' => '<string>',
            'source' => [
                'sourceData' => [
                    'acmPcaArn' => '<string>',
                    'x509CertificateData' => '<string>',
                ],
                'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
            ],
            'trustAnchorArn' => '<string>',
            'trustAnchorId' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

trustAnchors
  • Type: Array of TrustAnchorDetail structures

A list of trust anchors.

Errors

  • ValidationException:

    Validation exception error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

TagResource

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

Attaches tags to a resource.

Required permissions: rolesanywhere:TagResource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The ARN of the resource.

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

The tags to attach to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Validation exception error.

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • TooManyTagsException:

    Too many tags.

UntagResource

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

Removes tags from the resource.

Required permissions: rolesanywhere:UntagResource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The ARN of the resource.

tagKeys
  • Required: Yes
  • Type: Array of strings

A list of keys. Tag keys are the unique identifiers of tags.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Validation exception error.

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

UpdateCrl

$result = $client->updateCrl([/* ... */]);
$promise = $client->updateCrlAsync([/* ... */]);

Updates the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials.

Required permissions: rolesanywhere:UpdateCrl.

Parameter Syntax

$result = $client->updateCrl([
    'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
    'crlId' => '<string>', // REQUIRED
    'name' => '<string>',
]);

Parameter Details

Members
crlData
  • Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The x509 v3 specified certificate revocation list

crlId
  • Required: Yes
  • Type: string

The unique identifier of the certificate revocation list (CRL).

name
  • Type: string

The name of the Crl.

Result Syntax

[
    'crl' => [
        'createdAt' => <DateTime>,
        'crlArn' => '<string>',
        'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
        'crlId' => '<string>',
        'enabled' => true || false,
        'name' => '<string>',
        'trustAnchorArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
crl
  • Required: Yes
  • Type: CrlDetail structure

The state of the certificate revocation list (CRL) after a read or write operation.

Errors

  • ValidationException:

    Validation exception error.

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

UpdateProfile

$result = $client->updateProfile([/* ... */]);
$promise = $client->updateProfileAsync([/* ... */]);

Updates the profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can scope-down permissions with IAM managed policies.

Required permissions: rolesanywhere:UpdateProfile.

Parameter Syntax

$result = $client->updateProfile([
    'durationSeconds' => <integer>,
    'managedPolicyArns' => ['<string>', ...],
    'name' => '<string>',
    'profileId' => '<string>', // REQUIRED
    'roleArns' => ['<string>', ...],
    'sessionPolicy' => '<string>',
]);

Parameter Details

Members
durationSeconds
  • Type: int

The number of seconds the vended session credentials are valid for.

managedPolicyArns
  • Type: Array of strings

A list of managed policy ARNs that apply to the vended session credentials.

name
  • Type: string

The name of the profile.

profileId
  • Required: Yes
  • Type: string

The unique identifier of the profile.

roleArns
  • Type: Array of strings

A list of IAM roles that this profile can assume in a CreateSession operation.

sessionPolicy
  • Type: string

A session policy that applies to the trust boundary of the vended session credentials.

Result Syntax

[
    'profile' => [
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
profile
  • Type: ProfileDetail structure

The state of the profile after a read or write operation.

Errors

  • ValidationException:

    Validation exception error.

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

UpdateTrustAnchor

$result = $client->updateTrustAnchor([/* ... */]);
$promise = $client->updateTrustAnchorAsync([/* ... */]);

Updates the trust anchor.You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.

Required permissions: rolesanywhere:UpdateTrustAnchor.

Parameter Syntax

$result = $client->updateTrustAnchor([
    'name' => '<string>',
    'source' => [
        'sourceData' => [
            'acmPcaArn' => '<string>',
            'x509CertificateData' => '<string>',
        ],
        'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
    ],
    'trustAnchorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
  • Type: string

The name of the trust anchor.

source
  • Type: Source structure

The trust anchor type and its related certificate data.

trustAnchorId
  • Required: Yes
  • Type: string

The unique identifier of the trust anchor.

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
trustAnchor
  • Required: Yes
  • Type: TrustAnchorDetail structure

The state of the trust anchor after a read or write operation.

Errors

  • ValidationException:

    Validation exception error.

  • ResourceNotFoundException:

    The resource could not be found.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
message
  • Type: string

CredentialSummary

Description

A record of a presented X509 credential to CreateSession.

Members
enabled
  • Type: boolean

Indicates whether the credential is enabled.

failed
  • Type: boolean

Indicates whether the CreateSession operation was successful.

issuer
  • Type: string

The fully qualified domain name of the issuing certificate for the presented end-entity certificate.

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

The ISO-8601 time stamp of when the certificate was last used in a CreateSession operation.

serialNumber
  • Type: string

The serial number of the certificate.

x509CertificateData
  • Type: string

The PEM-encoded data of the certificate.

CrlDetail

Description

The state of the certificate revocation list (CRL) after a read or write operation.

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

The ISO-8601 timestamp when the certificate revocation list (CRL) was created.

crlArn
  • Type: string

The ARN of the certificate revocation list (CRL).

crlData
  • Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The state of the certificate revocation list (CRL) after a read or write operation.

crlId
  • Type: string

The unique identifier of the certificate revocation list (CRL).

enabled
  • Type: boolean

Indicates whether the certificate revocation list (CRL) is enabled.

name
  • Type: string

The name of the certificate revocation list (CRL).

trustAnchorArn
  • Type: string

The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.

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

The ISO-8601 timestamp when the certificate revocation list (CRL) was last updated.

InstanceProperty

Description

A key-value pair you set that identifies a property of the authenticating instance.

Members
failed
  • Type: boolean

Indicates whether the CreateSession operation was successful.

properties
  • Type: Associative array of custom strings keys (InstancePropertyMapKeyString) to strings

A list of instanceProperty objects.

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

The ISO-8601 time stamp of when the certificate was last used in a CreateSession operation.

ProfileDetail

Description

The state of the profile after a read or write operation.

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

The ISO-8601 timestamp when the profile was created.

createdBy
  • Type: string

The Amazon Web Services account that created the profile.

durationSeconds
  • Type: int

The number of seconds the vended session credentials are valid for.

enabled
  • Type: boolean

Indicates whether the profile is enabled.

managedPolicyArns
  • Type: Array of strings

A list of managed policy ARNs that apply to the vended session credentials.

name
  • Type: string

The name of the profile.

profileArn
  • Type: string

The ARN of the profile.

profileId
  • Type: string

The unique identifier of the profile.

requireInstanceProperties
  • Type: boolean

Specifies whether instance properties are required in CreateSession requests with this profile.

roleArns
  • Type: Array of strings

A list of IAM roles that this profile can assume in a CreateSession operation.

sessionPolicy
  • Type: string

A session policy that applies to the trust boundary of the vended session credentials.

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

The ISO-8601 timestamp when the profile was last updated.

ResourceNotFoundException

Description

The resource could not be found.

Members
message
  • Type: string

Source

Description

The trust anchor type and its related certificate data.

Members
sourceData
  • Type: SourceData structure

The data field of the trust anchor depending on its type.

sourceType
  • Type: string

The type of the trust anchor.

SourceData

Description

The data field of the trust anchor depending on its type.

Members
acmPcaArn
  • Type: string

The root certificate of the Certificate Manager Private Certificate Authority specified by this ARN is used in trust validation for CreateSession operations. Included for trust anchors of type AWS_ACM_PCA.

x509CertificateData
  • Type: string

The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE.

SubjectDetail

Description

The state of the subject after a read or write operation.

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

The ISO-8601 timestamp when the subject was created.

credentials
  • Type: Array of CredentialSummary structures

The temporary session credentials vended at the last authenticating call with this Subject.

enabled
  • Type: boolean

The enabled status of the subject.

instanceProperties
  • Type: Array of InstanceProperty structures

The specified instance properties associated with the request.

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

The ISO-8601 timestamp of the last time this Subject requested temporary session credentials.

subjectArn
  • Type: string

The ARN of the resource.

subjectId
  • Type: string

The id of the resource

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

The ISO-8601 timestamp when the subject was last updated.

x509Subject
  • Type: string

The x509 principal identifier of the authenticating certificate.

SubjectSummary

Description

A summary representation of Subject resources returned in read operations; primarily ListSubjects.

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

The ISO-8601 time stamp of when the certificate was first used in a CreateSession operation.

enabled
  • Type: boolean

The enabled status of the Subject.

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

The ISO-8601 time stamp of when the certificate was last used in a CreateSession operation.

subjectArn
  • Type: string

The ARN of the resource.

subjectId
  • Type: string

The id of the resource.

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

The ISO-8601 timestamp when the subject was last updated.

x509Subject
  • Type: string

The x509 principal identifier of the authenticating certificate.

Tag

Description

A label that consists of a key and value you define.

Members
key
  • Required: Yes
  • Type: string

The tag key.

value
  • Required: Yes
  • Type: string

The tag value.

TooManyTagsException

Description

Too many tags.

Members
message
  • Type: string

TrustAnchorDetail

Description

The state of the trust anchor after a read or write operation.

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

The ISO-8601 timestamp when the trust anchor was created.

enabled
  • Type: boolean

Indicates whether the trust anchor is enabled.

name
  • Type: string

The name of the trust anchor.

source
  • Type: Source structure

The trust anchor type and its related certificate data.

trustAnchorArn
  • Type: string

The ARN of the trust anchor.

trustAnchorId
  • Type: string

The unique identifier of the trust anchor.

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

The ISO-8601 timestamp when the trust anchor was last updated.

ValidationException

Description

Validation exception error.

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