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

Namespaces

  • Aws
    • AccessAnalyzer
      • Exception
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • AmplifyBackend
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • Appflow
      • Exception
    • AppIntegrationsService
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • AppRegistry
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • Batch
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchLogs
      • Exception
    • CodeArtifact
      • Exception
    • CodeBuild
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodeGuruProfiler
      • Exception
    • CodeGuruReviewer
      • Exception
    • CodePipeline
      • Exception
    • CodeStar
      • Exception
    • CodeStarconnections
      • Exception
    • CodeStarNotifications
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoIdentityProvider
      • Exception
    • CognitoSync
      • Exception
    • Comprehend
      • Exception
    • ComprehendMedical
      • Exception
    • ComputeOptimizer
      • Exception
    • ConfigService
      • Exception
    • Connect
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
      • Polyfill
    • CustomerProfiles
      • Exception
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • Detective
      • Exception
    • DeviceFarm
      • Exception
    • DevOpsGuru
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • 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
    • Endpoint
    • EndpointDiscovery
      • Exception
    • EventBridge
      • Exception
    • Exception
    • Firehose
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • 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
    • Iot
      • Exception
    • IoT1ClickDevicesService
      • Exception
    • IoT1ClickProjects
      • Exception
    • IoTAnalytics
      • Exception
    • IotDataPlane
      • Exception
    • IoTDeviceAdvisor
      • Exception
    • IoTEvents
      • Exception
    • IoTEventsData
      • Exception
    • IoTFleetHub
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • Kafka
      • Exception
    • kendra
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexModelsV2
      • Exception
    • LexRuntimeService
      • Exception
    • LexRuntimeV2
      • Exception
    • LicenseManager
      • Exception
    • Lightsail
      • Exception
    • LocationService
      • Exception
    • LookoutforVision
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • Macie2
      • Exception
    • ManagedBlockchain
      • 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
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Outposts
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrometheusService
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • Rekognition
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • Exception
    • Route53Resolver
      • Exception
    • S3
      • Crypto
      • Exception
      • RegionalEndpoint
        • Exception
      • UseArnRegion
        • Exception
    • S3Control
      • Exception
    • S3Outposts
      • Exception
    • SageMaker
      • Exception
    • SagemakerEdgeManager
      • Exception
    • SageMakerFeatureStoreRuntime
      • Exception
    • SageMakerRuntime
      • Exception
    • SavingsPlans
      • Exception
    • Schemas
      • Exception
    • SecretsManager
      • Exception
    • SecurityHub
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • ServiceQuotas
      • Exception
    • Ses
      • Exception
    • SesV2
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • signer
      • Exception
    • Sms
      • Exception
    • SnowBall
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSO
      • Exception
    • SSOAdmin
      • Exception
    • SSOOIDC
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
      • RegionalEndpoints
        • Exception
    • Support
      • Exception
    • Swf
      • Exception
    • Synthetics
      • Exception
    • Textract
      • Exception
    • TimestreamQuery
      • Exception
    • TimestreamWrite
      • Exception
    • TranscribeService
      • Exception
    • Transfer
      • Exception
    • Translate
      • Exception
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WellArchitected
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • 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\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • Aws\Appstream\AppstreamClient
  • Aws\AppSync\AppSyncClient
  • Aws\Athena\AthenaClient
  • Aws\AuditManager\AuditManagerClient
  • Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Backup\BackupClient
  • Aws\Batch\BatchClient
  • Aws\Braket\BraketClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudDirectory\CloudDirectoryClient
  • Aws\CloudFormation\CloudFormationClient
  • Aws\CloudFront\CloudFrontClient
  • Aws\CloudFront\CookieSigner
  • Aws\CloudFront\UrlSigner
  • Aws\CloudHsm\CloudHsmClient
  • Aws\CloudHSMV2\CloudHSMV2Client
  • Aws\CloudSearch\CloudSearchClient
  • Aws\CloudSearchDomain\CloudSearchDomainClient
  • Aws\CloudTrail\CloudTrailClient
  • Aws\CloudTrail\LogFileIterator
  • Aws\CloudTrail\LogFileReader
  • Aws\CloudTrail\LogRecordIterator
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CodeArtifact\CodeArtifactClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCommit\CodeCommitClient
  • Aws\CodeDeploy\CodeDeployClient
  • Aws\CodeGuruProfiler\CodeGuruProfilerClient
  • Aws\CodeGuruReviewer\CodeGuruReviewerClient
  • Aws\CodePipeline\CodePipelineClient
  • Aws\CodeStar\CodeStarClient
  • Aws\CodeStarconnections\CodeStarconnectionsClient
  • Aws\CodeStarNotifications\CodeStarNotificationsClient
  • Aws\CognitoIdentity\CognitoIdentityClient
  • Aws\CognitoIdentity\CognitoIdentityProvider
  • Aws\CognitoIdentityProvider\CognitoIdentityProviderClient
  • Aws\CognitoSync\CognitoSyncClient
  • Aws\Command
  • Aws\CommandPool
  • Aws\Comprehend\ComprehendClient
  • Aws\ComprehendMedical\ComprehendMedicalClient
  • Aws\ComputeOptimizer\ComputeOptimizerClient
  • Aws\ConfigService\ConfigServiceClient
  • Aws\Connect\ConnectClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • 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\Detective\DetectiveClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DevOpsGuru\DevOpsGuruClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DoctrineCacheAdapter
  • 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\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EventBridge\EventBridgeClient
  • Aws\Firehose\FirehoseClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FraudDetector\FraudDetectorClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • 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\Inspector\InspectorClient
  • Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient
  • Aws\IoT1ClickProjects\IoT1ClickProjectsClient
  • Aws\Iot\IotClient
  • Aws\IoTAnalytics\IoTAnalyticsClient
  • Aws\IotDataPlane\IotDataPlaneClient
  • Aws\IoTDeviceAdvisor\IoTDeviceAdvisorClient
  • Aws\IoTEvents\IoTEventsClient
  • Aws\IoTEventsData\IoTEventsDataClient
  • Aws\IoTFleetHub\IoTFleetHubClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTSiteWise\IoTSiteWiseClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\kendra\kendraClient
  • Aws\Kinesis\KinesisClient
  • Aws\KinesisAnalytics\KinesisAnalyticsClient
  • Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client
  • Aws\KinesisVideo\KinesisVideoClient
  • Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
  • Aws\KinesisVideoMedia\KinesisVideoMediaClient
  • Aws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient
  • Aws\Kms\KmsClient
  • Aws\LakeFormation\LakeFormationClient
  • Aws\Lambda\LambdaClient
  • Aws\LexModelBuildingService\LexModelBuildingServiceClient
  • Aws\LexModelsV2\LexModelsV2Client
  • Aws\LexRuntimeService\LexRuntimeServiceClient
  • Aws\LexRuntimeV2\LexRuntimeV2Client
  • Aws\LicenseManager\LicenseManagerClient
  • Aws\Lightsail\LightsailClient
  • Aws\LocationService\LocationServiceClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie2\Macie2Client
  • Aws\Macie\MacieClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • 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\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • 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\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Outposts\OutpostsClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrometheusService\PrometheusServiceClient
  • 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\Redshift\RedshiftClient
  • Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\Retry\Configuration
  • Aws\Retry\ConfigurationProvider
  • Aws\RoboMaker\RoboMakerClient
  • Aws\Route53\Route53Client
  • Aws\Route53Domains\Route53DomainsClient
  • Aws\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\S3Control\S3ControlClient
  • Aws\S3Outposts\S3OutpostsClient
  • Aws\SageMaker\SageMakerClient
  • Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient
  • Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
  • Aws\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\SavingsPlans\SavingsPlansClient
  • Aws\Schemas\SchemasClient
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\SecurityHub\SecurityHubClient
  • Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
  • Aws\ServiceCatalog\ServiceCatalogClient
  • Aws\ServiceDiscovery\ServiceDiscoveryClient
  • Aws\ServiceQuotas\ServiceQuotasClient
  • Aws\Ses\SesClient
  • Aws\SesV2\SesV2Client
  • Aws\Sfn\SfnClient
  • Aws\Shield\ShieldClient
  • Aws\Signature\AnonymousSignature
  • Aws\Signature\S3SignatureV4
  • Aws\Signature\SignatureProvider
  • Aws\Signature\SignatureV4
  • Aws\signer\signerClient
  • Aws\Sms\SmsClient
  • Aws\SnowBall\SnowBallClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSO\SSOClient
  • Aws\SSOAdmin\SSOAdminClient
  • Aws\SSOOIDC\SSOOIDCClient
  • Aws\StorageGateway\StorageGatewayClient
  • Aws\Sts\RegionalEndpoints\Configuration
  • Aws\Sts\RegionalEndpoints\ConfigurationProvider
  • Aws\Sts\StsClient
  • Aws\Support\SupportClient
  • Aws\Swf\SwfClient
  • Aws\Synthetics\SyntheticsClient
  • Aws\Textract\TextractClient
  • Aws\TimestreamQuery\TimestreamQueryClient
  • Aws\TimestreamWrite\TimestreamWriteClient
  • Aws\TraceMiddleware
  • Aws\TranscribeService\TranscribeServiceClient
  • Aws\Transfer\TransferClient
  • Aws\Translate\TranslateClient
  • Aws\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\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\DynamoDb\SessionConnectionInterface
  • Aws\Endpoint\PartitionInterface
  • Aws\EndpointDiscovery\ConfigurationInterface
  • Aws\HashInterface
  • Aws\MonitoringEventsInterface
  • Aws\ResponseContainerInterface
  • Aws\ResultInterface
  • Aws\Retry\ConfigurationInterface
  • Aws\S3\RegionalEndpoint\ConfigurationInterface
  • Aws\S3\S3ClientInterface
  • Aws\S3\UseArnRegion\ConfigurationInterface
  • Aws\Signature\SignatureInterface
  • Aws\Sts\RegionalEndpoints\ConfigurationInterface

Traits

  • Aws\Api\ErrorParser\JsonParserTrait
  • Aws\Api\Parser\MetadataParserTrait
  • Aws\Api\Parser\PayloadParserTrait
  • Aws\AwsClientTrait
  • Aws\Crypto\Cipher\CipherBuilderTrait
  • Aws\Crypto\DecryptionTrait
  • Aws\Crypto\DecryptionTraitV2
  • Aws\Crypto\EncryptionTrait
  • Aws\Crypto\EncryptionTraitV2
  • Aws\Crypto\Polyfill\NeedsTrait
  • Aws\DynamoDb\SessionConnectionConfigTrait
  • Aws\HasDataTrait
  • Aws\HasMonitoringEventsTrait
  • Aws\Retry\RetryHelperTrait
  • Aws\S3\Crypto\CryptoParamsTrait
  • Aws\S3\Crypto\CryptoParamsTraitV2
  • Aws\S3\Crypto\UserAgentTrait
  • Aws\S3\MultipartUploadingTrait
  • Aws\S3\S3ClientTrait
  • Aws\Signature\SignatureTrait

Exceptions

  • Aws\AccessAnalyzer\Exception\AccessAnalyzerException
  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\AmplifyBackend\Exception\AmplifyBackendException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\Appflow\Exception\AppflowException
  • Aws\AppIntegrationsService\Exception\AppIntegrationsServiceException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\AppRegistry\Exception\AppRegistryException
  • Aws\Appstream\Exception\AppstreamException
  • Aws\AppSync\Exception\AppSyncException
  • Aws\Arn\Exception\InvalidArnException
  • Aws\Athena\Exception\AthenaException
  • Aws\AuditManager\Exception\AuditManagerException
  • Aws\AugmentedAIRuntime\Exception\AugmentedAIRuntimeException
  • Aws\AutoScaling\Exception\AutoScalingException
  • Aws\AutoScalingPlans\Exception\AutoScalingPlansException
  • Aws\Backup\Exception\BackupException
  • Aws\Batch\Exception\BatchException
  • Aws\Braket\Exception\BraketException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • Aws\Cloud9\Exception\Cloud9Exception
  • Aws\CloudDirectory\Exception\CloudDirectoryException
  • Aws\CloudFormation\Exception\CloudFormationException
  • Aws\CloudFront\Exception\CloudFrontException
  • Aws\CloudHsm\Exception\CloudHsmException
  • Aws\CloudHSMV2\Exception\CloudHSMV2Exception
  • Aws\CloudSearch\Exception\CloudSearchException
  • Aws\CloudSearchDomain\Exception\CloudSearchDomainException
  • Aws\CloudTrail\Exception\CloudTrailException
  • Aws\CloudWatch\Exception\CloudWatchException
  • Aws\CloudWatchEvents\Exception\CloudWatchEventsException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CodeArtifact\Exception\CodeArtifactException
  • Aws\CodeBuild\Exception\CodeBuildException
  • Aws\CodeCommit\Exception\CodeCommitException
  • Aws\CodeDeploy\Exception\CodeDeployException
  • Aws\CodeGuruProfiler\Exception\CodeGuruProfilerException
  • Aws\CodeGuruReviewer\Exception\CodeGuruReviewerException
  • Aws\CodePipeline\Exception\CodePipelineException
  • Aws\CodeStar\Exception\CodeStarException
  • Aws\CodeStarconnections\Exception\CodeStarconnectionsException
  • Aws\CodeStarNotifications\Exception\CodeStarNotificationsException
  • Aws\CognitoIdentity\Exception\CognitoIdentityException
  • Aws\CognitoIdentityProvider\Exception\CognitoIdentityProviderException
  • Aws\CognitoSync\Exception\CognitoSyncException
  • Aws\Comprehend\Exception\ComprehendException
  • Aws\ComprehendMedical\Exception\ComprehendMedicalException
  • Aws\ComputeOptimizer\Exception\ComputeOptimizerException
  • Aws\ConfigService\Exception\ConfigServiceException
  • Aws\Connect\Exception\ConnectException
  • Aws\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • 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\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\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\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • Aws\Exception\CouldNotCreateChecksumException
  • Aws\Exception\CredentialsException
  • Aws\Exception\CryptoException
  • Aws\Exception\CryptoPolyfillException
  • Aws\Exception\EventStreamDataException
  • Aws\Exception\IncalculablePayloadException
  • Aws\Exception\InvalidJsonException
  • Aws\Exception\InvalidRegionException
  • Aws\Exception\MultipartUploadException
  • Aws\Exception\UnresolvedApiException
  • Aws\Exception\UnresolvedEndpointException
  • Aws\Exception\UnresolvedSignatureException
  • Aws\Firehose\Exception\FirehoseException
  • 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\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\Inspector\Exception\InspectorException
  • Aws\IoT1ClickDevicesService\Exception\IoT1ClickDevicesServiceException
  • Aws\IoT1ClickProjects\Exception\IoT1ClickProjectsException
  • Aws\Iot\Exception\IotException
  • Aws\IoTAnalytics\Exception\IoTAnalyticsException
  • Aws\IotDataPlane\Exception\IotDataPlaneException
  • Aws\IoTDeviceAdvisor\Exception\IoTDeviceAdvisorException
  • Aws\IoTEvents\Exception\IoTEventsException
  • Aws\IoTEventsData\Exception\IoTEventsDataException
  • Aws\IoTFleetHub\Exception\IoTFleetHubException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTSecureTunneling\Exception\IoTSecureTunnelingException
  • Aws\IoTSiteWise\Exception\IoTSiteWiseException
  • Aws\IoTThingsGraph\Exception\IoTThingsGraphException
  • Aws\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\Kafka\Exception\KafkaException
  • Aws\kendra\Exception\kendraException
  • Aws\Kinesis\Exception\KinesisException
  • Aws\KinesisAnalytics\Exception\KinesisAnalyticsException
  • Aws\KinesisAnalyticsV2\Exception\KinesisAnalyticsV2Exception
  • Aws\KinesisVideo\Exception\KinesisVideoException
  • Aws\KinesisVideoArchivedMedia\Exception\KinesisVideoArchivedMediaException
  • Aws\KinesisVideoMedia\Exception\KinesisVideoMediaException
  • Aws\KinesisVideoSignalingChannels\Exception\KinesisVideoSignalingChannelsException
  • Aws\Kms\Exception\KmsException
  • Aws\LakeFormation\Exception\LakeFormationException
  • Aws\Lambda\Exception\LambdaException
  • Aws\LexModelBuildingService\Exception\LexModelBuildingServiceException
  • Aws\LexModelsV2\Exception\LexModelsV2Exception
  • Aws\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\LexRuntimeV2\Exception\LexRuntimeV2Exception
  • Aws\LicenseManager\Exception\LicenseManagerException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\LocationService\Exception\LocationServiceException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie2\Exception\Macie2Exception
  • Aws\Macie\Exception\MacieException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • 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\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • 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\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Outposts\Exception\OutpostsException
  • 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\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\PrometheusService\Exception\PrometheusServiceException
  • 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\Redshift\Exception\RedshiftException
  • Aws\RedshiftDataAPIService\Exception\RedshiftDataAPIServiceException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\Retry\Exception\ConfigurationException
  • Aws\RoboMaker\Exception\RoboMakerException
  • Aws\Route53\Exception\Route53Exception
  • Aws\Route53Domains\Exception\Route53DomainsException
  • Aws\Route53Resolver\Exception\Route53ResolverException
  • Aws\S3\Exception\DeleteMultipleObjectsException
  • Aws\S3\Exception\PermanentRedirectException
  • Aws\S3\Exception\S3Exception
  • Aws\S3\Exception\S3MultipartUploadException
  • Aws\S3\RegionalEndpoint\Exception\ConfigurationException
  • Aws\S3\UseArnRegion\Exception\ConfigurationException
  • Aws\S3Control\Exception\S3ControlException
  • Aws\S3Outposts\Exception\S3OutpostsException
  • Aws\SageMaker\Exception\SageMakerException
  • Aws\SagemakerEdgeManager\Exception\SagemakerEdgeManagerException
  • Aws\SageMakerFeatureStoreRuntime\Exception\SageMakerFeatureStoreRuntimeException
  • Aws\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SavingsPlans\Exception\SavingsPlansException
  • Aws\Schemas\Exception\SchemasException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\SecurityHub\Exception\SecurityHubException
  • Aws\ServerlessApplicationRepository\Exception\ServerlessApplicationRepositoryException
  • Aws\ServiceCatalog\Exception\ServiceCatalogException
  • Aws\ServiceDiscovery\Exception\ServiceDiscoveryException
  • Aws\ServiceQuotas\Exception\ServiceQuotasException
  • Aws\Ses\Exception\SesException
  • Aws\SesV2\Exception\SesV2Exception
  • Aws\Sfn\Exception\SfnException
  • Aws\Shield\Exception\ShieldException
  • Aws\signer\Exception\signerException
  • Aws\Sms\Exception\SmsException
  • Aws\SnowBall\Exception\SnowBallException
  • Aws\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\SSO\Exception\SSOException
  • Aws\SSOAdmin\Exception\SSOAdminException
  • Aws\SSOOIDC\Exception\SSOOIDCException
  • Aws\StorageGateway\Exception\StorageGatewayException
  • Aws\Sts\Exception\StsException
  • Aws\Sts\RegionalEndpoints\Exception\ConfigurationException
  • Aws\Support\Exception\SupportException
  • Aws\Swf\Exception\SwfException
  • Aws\Synthetics\Exception\SyntheticsException
  • Aws\Textract\Exception\TextractException
  • Aws\TimestreamQuery\Exception\TimestreamQueryException
  • Aws\TimestreamWrite\Exception\TimestreamWriteException
  • Aws\TranscribeService\Exception\TranscribeServiceException
  • Aws\Transfer\Exception\TransferException
  • Aws\Translate\Exception\TranslateException
  • Aws\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\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_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

Amazon Elastic Kubernetes Service 2017-11-01

Client: Aws\EKS\EKSClient
Service ID: eks
Version: 2017-11-01

This page describes the parameters and results for the operations of the Amazon Elastic Kubernetes Service (2017-11-01), and shows how to use the Aws\EKS\EKSClient object to call the described operations. This documentation is specific to the 2017-11-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

  • CreateAddon ( array $params = [] )

    Creates an Amazon EKS add-on.

  • CreateCluster ( array $params = [] )

    Creates an Amazon EKS control plane.

  • CreateFargateProfile ( array $params = [] )

    Creates an AWS Fargate profile for your Amazon EKS cluster.

  • CreateNodegroup ( array $params = [] )

    Creates a managed worker node group for an Amazon EKS cluster.

  • DeleteAddon ( array $params = [] )

    Delete an Amazon EKS add-on.

  • DeleteCluster ( array $params = [] )

    Deletes the Amazon EKS cluster control plane.

  • DeleteFargateProfile ( array $params = [] )

    Deletes an AWS Fargate profile.

  • DeleteNodegroup ( array $params = [] )

    Deletes an Amazon EKS node group for a cluster.

  • DescribeAddon ( array $params = [] )

    Describes an Amazon EKS add-on.

  • DescribeAddonVersions ( array $params = [] )

    Describes the Kubernetes versions that the add-on can be used with.

  • DescribeCluster ( array $params = [] )

    Returns descriptive information about an Amazon EKS cluster.

  • DescribeFargateProfile ( array $params = [] )

    Returns descriptive information about an AWS Fargate profile.

  • DescribeNodegroup ( array $params = [] )

    Returns descriptive information about an Amazon EKS node group.

  • DescribeUpdate ( array $params = [] )

    Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.

  • ListAddons ( array $params = [] )

    Lists the available add-ons.

  • ListClusters ( array $params = [] )

    Lists the Amazon EKS clusters in your AWS account in the specified Region.

  • ListFargateProfiles ( array $params = [] )

    Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.

  • ListNodegroups ( array $params = [] )

    Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region.

  • ListTagsForResource ( array $params = [] )

    List the tags for an Amazon EKS resource.

  • ListUpdates ( array $params = [] )

    Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.

  • TagResource ( array $params = [] )

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

  • UntagResource ( array $params = [] )

    Deletes specified tags from a resource.

  • UpdateAddon ( array $params = [] )

    Updates an Amazon EKS add-on.

  • UpdateClusterConfig ( array $params = [] )

    Updates an Amazon EKS cluster configuration.

  • UpdateClusterVersion ( array $params = [] )

    Updates an Amazon EKS cluster to the specified Kubernetes version.

  • UpdateNodegroupConfig ( array $params = [] )

    Updates an Amazon EKS managed node group configuration.

  • UpdateNodegroupVersion ( array $params = [] )

    Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

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:

  • DescribeAddonVersions
  • ListAddons
  • ListClusters
  • ListFargateProfiles
  • ListNodegroups
  • ListUpdates

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
ClusterActive DescribeCluster 30 40
ClusterDeleted DescribeCluster 30 40
NodegroupActive DescribeNodegroup 30 80
NodegroupDeleted DescribeNodegroup 30 40
AddonActive DescribeAddon 10 60
AddonDeleted DescribeAddon 10 60

Operations

CreateAddon

$result = $client->createAddon([/* ... */]);
$promise = $client->createAddonAsync([/* ... */]);

Creates an Amazon EKS add-on.

Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. Amazon EKS add-ons can only be used with Amazon EKS clusters running version 1.18 with platform version eks.3 or later because add-ons rely on the Server-side Apply Kubernetes feature, which is only available in Kubernetes 1.18 and later.

Parameter Syntax

$result = $client->createAddon([
    'addonName' => '<string>', // REQUIRED
    'addonVersion' => '<string>',
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'resolveConflicts' => 'OVERWRITE|NONE',
    'serviceAccountRoleArn' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
addonName
  • Required: Yes
  • Type: string

The name of the add-on. The name must match one of the names returned by ListAddons .

addonVersion
  • Type: string

The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

clientRequestToken
  • Type: string

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

clusterName
  • Required: Yes
  • Type: string

The name of the cluster to create the add-on for.

resolveConflicts
  • Type: string

How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on.

serviceAccountRoleArn
  • Type: string

The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.

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

The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.

Result Syntax

[
    'addon' => [
        'addonArn' => '<string>',
        'addonName' => '<string>',
        'addonVersion' => '<string>',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AccessDenied|InternalFailure|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'modifiedAt' => <DateTime>,
        'serviceAccountRoleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|CREATE_FAILED|UPDATING|DELETING|DELETE_FAILED|DEGRADED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
addon
  • Type: Addon structure

An Amazon EKS add-on.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • InvalidRequestException:

    The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • ResourceInUseException:

    The specified resource is in use.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

CreateCluster

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

Creates an Amazon EKS control plane.

The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as etcd and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its own set of Amazon EC2 instances.

The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the worker nodes (for example, to support kubectl exec, logs, and proxy data flows).

Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.

You can use the endpointPublicAccess and endpointPrivateAccess parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

You can use the logging parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.

Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide.

Parameter Syntax

$result = $client->createCluster([
    'clientRequestToken' => '<string>',
    'encryptionConfig' => [
        [
            'provider' => [
                'keyArn' => '<string>',
            ],
            'resources' => ['<string>', ...],
        ],
        // ...
    ],
    'kubernetesNetworkConfig' => [
        'serviceIpv4Cidr' => '<string>',
    ],
    'logging' => [
        'clusterLogging' => [
            [
                'enabled' => true || false,
                'types' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'name' => '<string>', // REQUIRED
    'resourcesVpcConfig' => [ // REQUIRED
        'endpointPrivateAccess' => true || false,
        'endpointPublicAccess' => true || false,
        'publicAccessCidrs' => ['<string>', ...],
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'version' => '<string>',
]);

Parameter Details

Members
clientRequestToken
  • Type: string

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

encryptionConfig
  • Type: Array of EncryptionConfig structures

The encryption configuration for the cluster.

kubernetesNetworkConfig
  • Type: KubernetesNetworkConfigRequest structure

The Kubernetes network configuration for the cluster.

logging
  • Type: Logging structure

Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.

name
  • Required: Yes
  • Type: string

The unique name to give to your cluster.

resourcesVpcConfig
  • Required: Yes
  • Type: VpcConfigRequest structure

The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.

roleArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .

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

The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.

version
  • Type: string

The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.

Result Syntax

[
    'cluster' => [
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'createdAt' => <DateTime>,
        'encryptionConfig' => [
            [
                'provider' => [
                    'keyArn' => '<string>',
                ],
                'resources' => ['<string>', ...],
            ],
            // ...
        ],
        'endpoint' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'kubernetesNetworkConfig' => [
            'serviceIpv4Cidr' => '<string>',
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'publicAccessCidrs' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Members
cluster
  • Type: Cluster structure

The full description of your new cluster.

Errors

  • ResourceInUseException:

    The specified resource is in use.

  • ResourceLimitExceededException:

    You have encountered a service limit on the specified resource.

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ServiceUnavailableException:

    The service is unavailable. Back off and retry the operation.

  • UnsupportedAvailabilityZoneException:

    At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

Examples

Example 1: To create a new cluster

The following example creates an Amazon EKS cluster called prod.

$result = $client->createCluster([
    'version' => '1.10',
    'name' => 'prod',
    'clientRequestToken' => '1d2129a1-3d38-460a-9756-e5b91fddb951',
    'resourcesVpcConfig' => [
        'securityGroupIds' => [
            'sg-6979fe18',
        ],
        'subnetIds' => [
            'subnet-6782e71e',
            'subnet-e7e761ac',
        ],
    ],
    'roleArn' => 'arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI',
]);

Result syntax:

[
]

CreateFargateProfile

$result = $client->createFargateProfile([/* ... */]);
$promise = $client->createFargateProfileAsync([/* ... */]);

Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.

The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.

When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the kubelet that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide.

Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.

If any Fargate profiles in a cluster are in the DELETING status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.

For more information, see AWS Fargate Profile in the Amazon EKS User Guide.

Parameter Syntax

$result = $client->createFargateProfile([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'fargateProfileName' => '<string>', // REQUIRED
    'podExecutionRoleArn' => '<string>', // REQUIRED
    'selectors' => [
        [
            'labels' => ['<string>', ...],
            'namespace' => '<string>',
        ],
        // ...
    ],
    'subnets' => ['<string>', ...],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
clientRequestToken
  • Type: string

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

clusterName
  • Required: Yes
  • Type: string

The name of the Amazon EKS cluster to apply the Fargate profile to.

fargateProfileName
  • Required: Yes
  • Type: string

The name of the Fargate profile.

podExecutionRoleArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide.

selectors
  • Type: Array of FargateProfileSelector structures

The selectors to match for pods to use this Fargate profile. Each selector must have an associated namespace. Optionally, you can also specify labels for a namespace. You may specify up to five selectors in a Fargate profile.

subnets
  • Type: Array of strings

The IDs of subnets to launch your pods into. At this time, pods running on Fargate are not assigned public IP addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.

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

The metadata to apply to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.

Result Syntax

[
    'fargateProfile' => [
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'fargateProfileArn' => '<string>',
        'fargateProfileName' => '<string>',
        'podExecutionRoleArn' => '<string>',
        'selectors' => [
            [
                'labels' => ['<string>', ...],
                'namespace' => '<string>',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|CREATE_FAILED|DELETE_FAILED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
fargateProfile
  • Type: FargateProfile structure

The full description of your new Fargate profile.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • InvalidRequestException:

    The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ResourceLimitExceededException:

    You have encountered a service limit on the specified resource.

  • UnsupportedAvailabilityZoneException:

    At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

CreateNodegroup

$result = $client->createNodegroup([/* ... */]);
$promise = $client->createNodegroupAsync([/* ... */]);

Creates a managed worker node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Launch template support.

An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups in the Amazon EKS User Guide.

Parameter Syntax

$result = $client->createNodegroup([
    'amiType' => 'AL2_x86_64|AL2_x86_64_GPU|AL2_ARM_64',
    'capacityType' => 'ON_DEMAND|SPOT',
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'diskSize' => <integer>,
    'instanceTypes' => ['<string>', ...],
    'labels' => ['<string>', ...],
    'launchTemplate' => [
        'id' => '<string>',
        'name' => '<string>',
        'version' => '<string>',
    ],
    'nodeRole' => '<string>', // REQUIRED
    'nodegroupName' => '<string>', // REQUIRED
    'releaseVersion' => '<string>',
    'remoteAccess' => [
        'ec2SshKey' => '<string>',
        'sourceSecurityGroups' => ['<string>', ...],
    ],
    'scalingConfig' => [
        'desiredSize' => <integer>,
        'maxSize' => <integer>,
        'minSize' => <integer>,
    ],
    'subnets' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
    'version' => '<string>',
]);

Parameter Details

Members
amiType
  • Type: string

The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type. Non-GPU instances should use the AL2_x86_64 AMI type. Arm instances should use the AL2_ARM_64 AMI type. All types use the Amazon EKS optimized Amazon Linux 2 AMI. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

capacityType
  • Type: string

The capacity type for your node group.

clientRequestToken
  • Type: string

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

clusterName
  • Required: Yes
  • Type: string

The name of the cluster to create the node group in.

diskSize
  • Type: int

The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB. If you specify launchTemplate, then don't specify diskSize, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

instanceTypes
  • Type: Array of strings

Specify the instance types for a node group. If you specify a GPU instance type, be sure to specify AL2_x86_64_GPU with the amiType parameter. If you specify launchTemplate, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes. If however, you specify an instance type in your launch template and specify any instanceTypes, the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes, then t3.medium is used, by default. If you specify Spot for capacityType, then we recommend specifying multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide.

labels
  • Type: Associative array of custom strings keys (labelKey) to strings

The Kubernetes labels to be applied to the nodes in the node group when they are created.

launchTemplate
  • Type: LaunchTemplateSpecification structure

An object representing a node group's launch template specification. If specified, then do not specify instanceTypes, diskSize, or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification.

nodeRole
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker Node IAM Role in the Amazon EKS User Guide . If you specify launchTemplate, then don't specify IamInstanceProfile in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

nodegroupName
  • Required: Yes
  • Type: string

The unique name to give your node group.

releaseVersion
  • Type: string

The AMI version of the Amazon EKS optimized AMI to use with your node group. By default, the latest available AMI version for the node group's current Kubernetes version is used. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

remoteAccess
  • Type: RemoteAccessConfig structure

The remote access (SSH) configuration to use with your node group. If you specify launchTemplate, then don't specify remoteAccess, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

scalingConfig
  • Type: NodegroupScalingConfig structure

The scaling configuration details for the Auto Scaling group that is created for your node group.

subnets
  • Required: Yes
  • Type: Array of strings

The subnets to use for the Auto Scaling group that is created for your node group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME with a value of shared, where CLUSTER_NAME is replaced with the name of your cluster. If you specify launchTemplate, then don't specify SubnetId in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

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

The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

version
  • Type: string

The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Result Syntax

[
    'nodegroup' => [
        'amiType' => 'AL2_x86_64|AL2_x86_64_GPU|AL2_ARM_64',
        'capacityType' => 'ON_DEMAND|SPOT',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'diskSize' => <integer>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AutoScalingGroupNotFound|AutoScalingGroupInvalidConfiguration|Ec2SecurityGroupNotFound|Ec2SecurityGroupDeletionFailure|Ec2LaunchTemplateNotFound|Ec2LaunchTemplateVersionMismatch|Ec2SubnetNotFound|Ec2SubnetInvalidConfiguration|IamInstanceProfileNotFound|IamLimitExceeded|IamNodeRoleNotFound|NodeCreationFailure|AsgInstanceLaunchFailures|InstanceLimitExceeded|InsufficientFreeAddresses|AccessDenied|InternalFailure|ClusterUnreachable',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'instanceTypes' => ['<string>', ...],
        'labels' => ['<string>', ...],
        'launchTemplate' => [
            'id' => '<string>',
            'name' => '<string>',
            'version' => '<string>',
        ],
        'modifiedAt' => <DateTime>,
        'nodeRole' => '<string>',
        'nodegroupArn' => '<string>',
        'nodegroupName' => '<string>',
        'releaseVersion' => '<string>',
        'remoteAccess' => [
            'ec2SshKey' => '<string>',
            'sourceSecurityGroups' => ['<string>', ...],
        ],
        'resources' => [
            'autoScalingGroups' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'remoteAccessSecurityGroup' => '<string>',
        ],
        'scalingConfig' => [
            'desiredSize' => <integer>,
            'maxSize' => <integer>,
            'minSize' => <integer>,
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|DEGRADED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Members
nodegroup
  • Type: Nodegroup structure

The full description of your new node group.

Errors

  • ResourceInUseException:

    The specified resource is in use.

  • ResourceLimitExceededException:

    You have encountered a service limit on the specified resource.

  • InvalidRequestException:

    The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ServiceUnavailableException:

    The service is unavailable. Back off and retry the operation.

DeleteAddon

$result = $client->deleteAddon([/* ... */]);
$promise = $client->deleteAddonAsync([/* ... */]);

Delete an Amazon EKS add-on.

When you remove the add-on, it will also be deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.

Parameter Syntax

$result = $client->deleteAddon([
    'addonName' => '<string>', // REQUIRED
    'clusterName' => '<string>', // REQUIRED
]);

Parameter Details

Members
addonName
  • Required: Yes
  • Type: string

The name of the add-on. The name must match one of the names returned by ListAddons .

clusterName
  • Required: Yes
  • Type: string

The name of the cluster to delete the add-on from.

Result Syntax

[
    'addon' => [
        'addonArn' => '<string>',
        'addonName' => '<string>',
        'addonVersion' => '<string>',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AccessDenied|InternalFailure|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'modifiedAt' => <DateTime>,
        'serviceAccountRoleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|CREATE_FAILED|UPDATING|DELETING|DELETE_FAILED|DEGRADED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
addon
  • Type: Addon structure

An Amazon EKS add-on.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • InvalidRequestException:

    The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

DeleteCluster

$result = $client->deleteCluster([/* ... */]);
$promise = $client->deleteClusterAsync([/* ... */]);

Deletes the Amazon EKS cluster control plane.

If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide.

If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.

Parameter Syntax

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

Parameter Details

Members
name
  • Required: Yes
  • Type: string

The name of the cluster to delete.

Result Syntax

[
    'cluster' => [
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'createdAt' => <DateTime>,
        'encryptionConfig' => [
            [
                'provider' => [
                    'keyArn' => '<string>',
                ],
                'resources' => ['<string>', ...],
            ],
            // ...
        ],
        'endpoint' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'kubernetesNetworkConfig' => [
            'serviceIpv4Cidr' => '<string>',
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'publicAccessCidrs' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Members
cluster
  • Type: Cluster structure

The full description of the cluster to delete.

Errors

  • ResourceInUseException:

    The specified resource is in use.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ServiceUnavailableException:

    The service is unavailable. Back off and retry the operation.

Examples

Example 1: To delete a cluster

This example command deletes a cluster named `devel` in your default region.

$result = $client->deleteCluster([
    'name' => 'devel',
]);

Result syntax:

[
]

DeleteFargateProfile

$result = $client->deleteFargateProfile([/* ... */]);
$promise = $client->deleteFargateProfileAsync([/* ... */]);

Deletes an AWS Fargate profile.

When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.

Only one Fargate profile in a cluster can be in the DELETING status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster.

Parameter Syntax

$result = $client->deleteFargateProfile([
    'clusterName' => '<string>', // REQUIRED
    'fargateProfileName' => '<string>', // REQUIRED
]);

Parameter Details

Members
clusterName
  • Required: Yes
  • Type: string

The name of the Amazon EKS cluster associated with the Fargate profile to delete.

fargateProfileName
  • Required: Yes
  • Type: string

The name of the Fargate profile to delete.

Result Syntax

[
    'fargateProfile' => [
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'fargateProfileArn' => '<string>',
        'fargateProfileName' => '<string>',
        'podExecutionRoleArn' => '<string>',
        'selectors' => [
            [
                'labels' => ['<string>', ...],
                'namespace' => '<string>',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|CREATE_FAILED|DELETE_FAILED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
fargateProfile
  • Type: FargateProfile structure

The deleted Fargate profile.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

DeleteNodegroup

$result = $client->deleteNodegroup([/* ... */]);
$promise = $client->deleteNodegroupAsync([/* ... */]);

Deletes an Amazon EKS node group for a cluster.

Parameter Syntax

$result = $client->deleteNodegroup([
    'clusterName' => '<string>', // REQUIRED
    'nodegroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
clusterName
  • Required: Yes
  • Type: string

The name of the Amazon EKS cluster that is associated with your node group.

nodegroupName
  • Required: Yes
  • Type: string

The name of the node group to delete.

Result Syntax

[
    'nodegroup' => [
        'amiType' => 'AL2_x86_64|AL2_x86_64_GPU|AL2_ARM_64',
        'capacityType' => 'ON_DEMAND|SPOT',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'diskSize' => <integer>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AutoScalingGroupNotFound|AutoScalingGroupInvalidConfiguration|Ec2SecurityGroupNotFound|Ec2SecurityGroupDeletionFailure|Ec2LaunchTemplateNotFound|Ec2LaunchTemplateVersionMismatch|Ec2SubnetNotFound|Ec2SubnetInvalidConfiguration|IamInstanceProfileNotFound|IamLimitExceeded|IamNodeRoleNotFound|NodeCreationFailure|AsgInstanceLaunchFailures|InstanceLimitExceeded|InsufficientFreeAddresses|AccessDenied|InternalFailure|ClusterUnreachable',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'instanceTypes' => ['<string>', ...],
        'labels' => ['<string>', ...],
        'launchTemplate' => [
            'id' => '<string>',
            'name' => '<string>',
            'version' => '<string>',
        ],
        'modifiedAt' => <DateTime>,
        'nodeRole' => '<string>',
        'nodegroupArn' => '<string>',
        'nodegroupName' => '<string>',
        'releaseVersion' => '<string>',
        'remoteAccess' => [
            'ec2SshKey' => '<string>',
            'sourceSecurityGroups' => ['<string>', ...],
        ],
        'resources' => [
            'autoScalingGroups' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'remoteAccessSecurityGroup' => '<string>',
        ],
        'scalingConfig' => [
            'desiredSize' => <integer>,
            'maxSize' => <integer>,
            'minSize' => <integer>,
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|DEGRADED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Members
nodegroup
  • Type: Nodegroup structure

The full description of your deleted node group.

Errors

  • ResourceInUseException:

    The specified resource is in use.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ServiceUnavailableException:

    The service is unavailable. Back off and retry the operation.

DescribeAddon

$result = $client->describeAddon([/* ... */]);
$promise = $client->describeAddonAsync([/* ... */]);

Describes an Amazon EKS add-on.

Parameter Syntax

$result = $client->describeAddon([
    'addonName' => '<string>', // REQUIRED
    'clusterName' => '<string>', // REQUIRED
]);

Parameter Details

Members
addonName
  • Required: Yes
  • Type: string

The name of the add-on. The name must match one of the names returned by ListAddons .

clusterName
  • Required: Yes
  • Type: string

The name of the cluster.

Result Syntax

[
    'addon' => [
        'addonArn' => '<string>',
        'addonName' => '<string>',
        'addonVersion' => '<string>',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AccessDenied|InternalFailure|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'modifiedAt' => <DateTime>,
        'serviceAccountRoleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|CREATE_FAILED|UPDATING|DELETING|DELETE_FAILED|DEGRADED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
addon
  • Type: Addon structure

An Amazon EKS add-on.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • InvalidRequestException:

    The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

DescribeAddonVersions

$result = $client->describeAddonVersions([/* ... */]);
$promise = $client->describeAddonVersionsAsync([/* ... */]);

Describes the Kubernetes versions that the add-on can be used with.

Parameter Syntax

$result = $client->describeAddonVersions([
    'addonName' => '<string>',
    'kubernetesVersion' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
addonName
  • Type: string

The name of the add-on. The name must match one of the names returned by ListAddons .

kubernetesVersion
  • Type: string

The Kubernetes versions that the add-on can be used with.

maxResults
  • Type: int

The maximum number of results to return.

nextToken
  • Type: string

The nextToken value returned from a previous paginated DescribeAddonVersionsRequest where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Result Syntax

[
    'addons' => [
        [
            'addonName' => '<string>',
            'addonVersions' => [
                [
                    'addonVersion' => '<string>',
                    'architecture' => ['<string>', ...],
                    'compatibilities' => [
                        [
                            'clusterVersion' => '<string>',
                            'defaultVersion' => true || false,
                            'platformVersions' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'type' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
addons
  • Type: Array of AddonInfo structures

The list of available versions with Kubernetes version compatibility.

nextToken
  • Type: string

The nextToken value returned from a previous paginated DescribeAddonVersionsResponse where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Errors

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

DescribeCluster

$result = $client->describeCluster([/* ... */]);
$promise = $client->describeClusterAsync([/* ... */]);

Returns descriptive information about an Amazon EKS cluster.

The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS.

The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.

Parameter Syntax

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

Parameter Details

Members
name
  • Required: Yes
  • Type: string

The name of the cluster to describe.

Result Syntax

[
    'cluster' => [
        'arn' => '<string>',
        'certificateAuthority' => [
            'data' => '<string>',
        ],
        'clientRequestToken' => '<string>',
        'createdAt' => <DateTime>,
        'encryptionConfig' => [
            [
                'provider' => [
                    'keyArn' => '<string>',
                ],
                'resources' => ['<string>', ...],
            ],
            // ...
        ],
        'endpoint' => '<string>',
        'identity' => [
            'oidc' => [
                'issuer' => '<string>',
            ],
        ],
        'kubernetesNetworkConfig' => [
            'serviceIpv4Cidr' => '<string>',
        ],
        'logging' => [
            'clusterLogging' => [
                [
                    'enabled' => true || false,
                    'types' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'name' => '<string>',
        'platformVersion' => '<string>',
        'resourcesVpcConfig' => [
            'clusterSecurityGroupId' => '<string>',
            'endpointPrivateAccess' => true || false,
            'endpointPublicAccess' => true || false,
            'publicAccessCidrs' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Members
cluster
  • Type: Cluster structure

The full description of your specified cluster.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ServiceUnavailableException:

    The service is unavailable. Back off and retry the operation.

Examples

Example 1: To describe a cluster

This example command provides a description of the specified cluster in your default region.

$result = $client->describeCluster([
    'name' => 'devel',
]);

Result syntax:

[
    'cluster' => [
        'version' => '1.10',
        'name' => 'devel',
        'arn' => 'arn:aws:eks:us-west-2:012345678910:cluster/devel',
        'certificateAuthority' => [
            'data' => 'LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=',
        ],
        'createdAt' => ,
        'endpoint' => 'https://A0DCCD80A04F01705DD065655C30CC3D.yl4.us-west-2.eks.amazonaws.com',
        'resourcesVpcConfig' => [
            'securityGroupIds' => [
                'sg-6979fe18',
            ],
            'subnetIds' => [
                'subnet-6782e71e',
                'subnet-e7e761ac',
            ],
            'vpcId' => 'vpc-950809ec',
        ],
        'roleArn' => 'arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI',
        'status' => 'ACTIVE',
    ],
]

DescribeFargateProfile

$result = $client->describeFargateProfile([/* ... */]);
$promise = $client->describeFargateProfileAsync([/* ... */]);

Returns descriptive information about an AWS Fargate profile.

Parameter Syntax

$result = $client->describeFargateProfile([
    'clusterName' => '<string>', // REQUIRED
    'fargateProfileName' => '<string>', // REQUIRED
]);

Parameter Details

Members
clusterName
  • Required: Yes
  • Type: string

The name of the Amazon EKS cluster associated with the Fargate profile.

fargateProfileName
  • Required: Yes
  • Type: string

The name of the Fargate profile to describe.

Result Syntax

[
    'fargateProfile' => [
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'fargateProfileArn' => '<string>',
        'fargateProfileName' => '<string>',
        'podExecutionRoleArn' => '<string>',
        'selectors' => [
            [
                'labels' => ['<string>', ...],
                'namespace' => '<string>',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|CREATE_FAILED|DELETE_FAILED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
fargateProfile
  • Type: FargateProfile structure

The full description of your Fargate profile.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

DescribeNodegroup

$result = $client->describeNodegroup([/* ... */]);
$promise = $client->describeNodegroupAsync([/* ... */]);

Returns descriptive information about an Amazon EKS node group.

Parameter Syntax

$result = $client->describeNodegroup([
    'clusterName' => '<string>', // REQUIRED
    'nodegroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
clusterName
  • Required: Yes
  • Type: string

The name of the Amazon EKS cluster associated with the node group.

nodegroupName
  • Required: Yes
  • Type: string

The name of the node group to describe.

Result Syntax

[
    'nodegroup' => [
        'amiType' => 'AL2_x86_64|AL2_x86_64_GPU|AL2_ARM_64',
        'capacityType' => 'ON_DEMAND|SPOT',
        'clusterName' => '<string>',
        'createdAt' => <DateTime>,
        'diskSize' => <integer>,
        'health' => [
            'issues' => [
                [
                    'code' => 'AutoScalingGroupNotFound|AutoScalingGroupInvalidConfiguration|Ec2SecurityGroupNotFound|Ec2SecurityGroupDeletionFailure|Ec2LaunchTemplateNotFound|Ec2LaunchTemplateVersionMismatch|Ec2SubnetNotFound|Ec2SubnetInvalidConfiguration|IamInstanceProfileNotFound|IamLimitExceeded|IamNodeRoleNotFound|NodeCreationFailure|AsgInstanceLaunchFailures|InstanceLimitExceeded|InsufficientFreeAddresses|AccessDenied|InternalFailure|ClusterUnreachable',
                    'message' => '<string>',
                    'resourceIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'instanceTypes' => ['<string>', ...],
        'labels' => ['<string>', ...],
        'launchTemplate' => [
            'id' => '<string>',
            'name' => '<string>',
            'version' => '<string>',
        ],
        'modifiedAt' => <DateTime>,
        'nodeRole' => '<string>',
        'nodegroupArn' => '<string>',
        'nodegroupName' => '<string>',
        'releaseVersion' => '<string>',
        'remoteAccess' => [
            'ec2SshKey' => '<string>',
            'sourceSecurityGroups' => ['<string>', ...],
        ],
        'resources' => [
            'autoScalingGroups' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'remoteAccessSecurityGroup' => '<string>',
        ],
        'scalingConfig' => [
            'desiredSize' => <integer>,
            'maxSize' => <integer>,
            'minSize' => <integer>,
        ],
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|DELETE_FAILED|DEGRADED',
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Members
nodegroup
  • Type: Nodegroup structure

The full description of your node group.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ServiceUnavailableException:

    The service is unavailable. Back off and retry the operation.

DescribeUpdate

$result = $client->describeUpdate([/* ... */]);
$promise = $client->describeUpdateAsync([/* ... */]);

Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.

When the status of the update is Succeeded, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.

Parameter Syntax

$result = $client->describeUpdate([
    'addonName' => '<string>',
    'name' => '<string>', // REQUIRED
    'nodegroupName' => '<string>',
    'updateId' => '<string>', // REQUIRED
]);

Parameter Details

Members
addonName
  • Type: string

The name of the add-on. The name must match one of the names returned by ListAddons .

name
  • Required: Yes
  • Type: string

The name of the Amazon EKS cluster associated with the update.

nodegroupName
  • Type: string

The name of the Amazon EKS node group associated with the update.

updateId
  • Required: Yes
  • Type: string

The ID of the update to describe.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion|PublicAccessCidrs|AddonVersion|ServiceAccountRoleArn|ResolveConflicts',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AddonUpdate',
    ],
]

Result Details

Members
update
  • Type: Update structure

The full description of the specified update.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

ListAddons

$result = $client->listAddons([/* ... */]);
$promise = $client->listAddonsAsync([/* ... */]);

Lists the available add-ons.

Parameter Syntax

$result = $client->listAddons([
    'clusterName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
clusterName
  • Required: Yes
  • Type: string

The name of the cluster.

maxResults
  • Type: int

The maximum number of add-on results returned by ListAddonsRequest in paginated output. When you use this parameter, ListAddonsRequest returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListAddonsRequest request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListAddonsRequest returns up to 100 results and a nextToken value, if applicable.

nextToken
  • Type: string

The nextToken value returned from a previous paginated ListAddonsRequest where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Result Syntax

[
    'addons' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Members
addons
  • Type: Array of strings

A list of available add-ons.

nextToken
  • Type: string

The nextToken value returned from a previous paginated ListAddonsResponse where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • InvalidRequestException:

    The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • ServerException:

    These errors are usually caused by a server-side issue.

ListClusters

$result = $client->listClusters([/* ... */]);
$promise = $client->listClustersAsync([/* ... */]);

Lists the Amazon EKS clusters in your AWS account in the specified Region.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.

nextToken
  • Type: string

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Result Syntax

[
    'clusters' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Members
clusters
  • Type: Array of strings

A list of all of the clusters for your account in the specified Region.

nextToken
  • Type: string

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ServiceUnavailableException:

    The service is unavailable. Back off and retry the operation.

Examples

Example 1: To list your available clusters

This example command lists all of your available clusters in your default region.

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

Result syntax:

[
    'clusters' => [
        'devel',
        'prod',
    ],
]

ListFargateProfiles

$result = $client->listFargateProfiles([/* ... */]);
$promise = $client->listFargateProfilesAsync([/* ... */]);

Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.

Parameter Syntax

$result = $client->listFargateProfiles([
    'clusterName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
clusterName
  • Required: Yes
  • Type: string

The name of the Amazon EKS cluster that you would like to listFargate profiles in.

maxResults
  • Type: int

The maximum number of Fargate profile results returned by ListFargateProfiles in paginated output. When you use this parameter, ListFargateProfiles returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListFargateProfiles request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListFargateProfiles returns up to 100 results and a nextToken value if applicable.

nextToken
  • Type: string

The nextToken value returned from a previous paginated ListFargateProfiles request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Result Syntax

[
    'fargateProfileNames' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Members
fargateProfileNames
  • Type: Array of strings

A list of all of the Fargate profiles associated with the specified cluster.

nextToken
  • Type: string

The nextToken value to include in a future ListFargateProfiles request. When the results of a ListFargateProfiles request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

ListNodegroups

$result = $client->listNodegroups([/* ... */]);
$promise = $client->listNodegroupsAsync([/* ... */]);

Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region. Self-managed node groups are not listed.

Parameter Syntax

$result = $client->listNodegroups([
    'clusterName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
clusterName
  • Required: Yes
  • Type: string

The name of the Amazon EKS cluster that you would like to list node groups in.

maxResults
  • Type: int

The maximum number of node group results returned by ListNodegroups in paginated output. When you use this parameter, ListNodegroups returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListNodegroups request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListNodegroups returns up to 100 results and a nextToken value if applicable.

nextToken
  • Type: string

The nextToken value returned from a previous paginated ListNodegroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Result Syntax

[
    'nextToken' => '<string>',
    'nodegroups' => ['<string>', ...],
]

Result Details

Members
nextToken
  • Type: string

The nextToken value to include in a future ListNodegroups request. When the results of a ListNodegroups request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

nodegroups
  • Type: Array of strings

A list of all of the node groups associated with the specified cluster.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ServiceUnavailableException:

    The service is unavailable. Back off and retry the operation.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

ListTagsForResource

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

List the tags for an Amazon EKS resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.

Result Syntax

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

Result Details

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

The tags for the resource.

Errors

  • BadRequestException:

    This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

  • NotFoundException:

    A service resource associated with the request could not be found. Clients should not retry such requests.

Examples

Example 1: To list tags for a cluster

This example lists all of the tags for the `beta` cluster.

$result = $client->listTagsForResource([
    'resourceArn' => 'arn:aws:eks:us-west-2:012345678910:cluster/beta',
]);

Result syntax:

[
    'tags' => [
        'aws:tag:domain' => 'beta',
    ],
]

ListUpdates

$result = $client->listUpdates([/* ... */]);
$promise = $client->listUpdatesAsync([/* ... */]);

Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.

Parameter Syntax

$result = $client->listUpdates([
    'addonName' => '<string>',
    'maxResults' => <integer>,
    'name' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'nodegroupName' => '<string>',
]);

Parameter Details

Members
addonName
  • Type: string

The names of the installed add-ons that have available updates.

maxResults
  • Type: int

The maximum number of update results returned by ListUpdates in paginated output. When you use this parameter, ListUpdates returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListUpdates request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListUpdates returns up to 100 results and a nextToken value if applicable.

name
  • Required: Yes
  • Type: string

The name of the Amazon EKS cluster to list updates for.

nextToken
  • Type: string

The nextToken value returned from a previous paginated ListUpdates request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

nodegroupName
  • Type: string

The name of the Amazon EKS managed node group to list updates for.

Result Syntax

[
    'nextToken' => '<string>',
    'updateIds' => ['<string>', ...],
]

Result Details

Members
nextToken
  • Type: string

The nextToken value to include in a future ListUpdates request. When the results of a ListUpdates request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

updateIds
  • Type: Array of strings

A list of all the updates for the specified cluster and Region.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

TagResource

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

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag does not automatically propagate to the subnets and worker nodes associated with the cluster.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.

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

The tags to add to the resource. A tag is an array of key-value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BadRequestException:

    This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

  • NotFoundException:

    A service resource associated with the request could not be found. Clients should not retry such requests.

UntagResource

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

Deletes specified tags from a resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.

tagKeys
  • Required: Yes
  • Type: Array of strings

The keys of the tags to be removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BadRequestException:

    This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

  • NotFoundException:

    A service resource associated with the request could not be found. Clients should not retry such requests.

UpdateAddon

$result = $client->updateAddon([/* ... */]);
$promise = $client->updateAddonAsync([/* ... */]);

Updates an Amazon EKS add-on.

Parameter Syntax

$result = $client->updateAddon([
    'addonName' => '<string>', // REQUIRED
    'addonVersion' => '<string>',
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'resolveConflicts' => 'OVERWRITE|NONE',
    'serviceAccountRoleArn' => '<string>',
]);

Parameter Details

Members
addonName
  • Required: Yes
  • Type: string

The name of the add-on. The name must match one of the names returned by ListAddons .

addonVersion
  • Type: string

The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

clientRequestToken
  • Type: string

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

clusterName
  • Required: Yes
  • Type: string

The name of the cluster.

resolveConflicts
  • Type: string

How to resolve parameter value conflicts when applying the new version of the add-on to the cluster.

serviceAccountRoleArn
  • Type: string

The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion|PublicAccessCidrs|AddonVersion|ServiceAccountRoleArn|ResolveConflicts',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AddonUpdate',
    ],
]

Result Details

Members
update
  • Type: Update structure

An object representing an asynchronous update.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • InvalidRequestException:

    The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • ResourceInUseException:

    The specified resource is in use.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

UpdateClusterConfig

$result = $client->updateClusterConfig([/* ... */]);
$promise = $client->updateClusterConfigAsync([/* ... */]);

Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.

You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

At this time, you can not update the subnets or security group IDs for an existing cluster.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.

Parameter Syntax

$result = $client->updateClusterConfig([
    'clientRequestToken' => '<string>',
    'logging' => [
        'clusterLogging' => [
            [
                'enabled' => true || false,
                'types' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'name' => '<string>', // REQUIRED
    'resourcesVpcConfig' => [
        'endpointPrivateAccess' => true || false,
        'endpointPublicAccess' => true || false,
        'publicAccessCidrs' => ['<string>', ...],
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Members
clientRequestToken
  • Type: string

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

logging
  • Type: Logging structure

Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.

name
  • Required: Yes
  • Type: string

The name of the Amazon EKS cluster to update.

resourcesVpcConfig
  • Type: VpcConfigRequest structure

An object representing the VPC configuration to use for an Amazon EKS cluster.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion|PublicAccessCidrs|AddonVersion|ServiceAccountRoleArn|ResolveConflicts',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AddonUpdate',
    ],
]

Result Details

Members
update
  • Type: Update structure

An object representing an asynchronous update.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ResourceInUseException:

    The specified resource is in use.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • InvalidRequestException:

    The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

UpdateClusterVersion

$result = $client->updateClusterVersion([/* ... */]);
$promise = $client->updateClusterVersionAsync([/* ... */]);

Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.

If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.

Parameter Syntax

$result = $client->updateClusterVersion([
    'clientRequestToken' => '<string>',
    'name' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientRequestToken
  • Type: string

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

name
  • Required: Yes
  • Type: string

The name of the Amazon EKS cluster to update.

version
  • Required: Yes
  • Type: string

The desired Kubernetes version following a successful update.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion|PublicAccessCidrs|AddonVersion|ServiceAccountRoleArn|ResolveConflicts',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AddonUpdate',
    ],
]

Result Details

Members
update
  • Type: Update structure

The full description of the specified update

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ResourceInUseException:

    The specified resource is in use.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • InvalidRequestException:

    The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

UpdateNodegroupConfig

$result = $client->updateNodegroupConfig([/* ... */]);
$promise = $client->updateNodegroupConfigAsync([/* ... */]);

Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.

Parameter Syntax

$result = $client->updateNodegroupConfig([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'labels' => [
        'addOrUpdateLabels' => ['<string>', ...],
        'removeLabels' => ['<string>', ...],
    ],
    'nodegroupName' => '<string>', // REQUIRED
    'scalingConfig' => [
        'desiredSize' => <integer>,
        'maxSize' => <integer>,
        'minSize' => <integer>,
    ],
]);

Parameter Details

Members
clientRequestToken
  • Type: string

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

clusterName
  • Required: Yes
  • Type: string

The name of the Amazon EKS cluster that the managed node group resides in.

labels
  • Type: UpdateLabelsPayload structure

The Kubernetes labels to be applied to the nodes in the node group after the update.

nodegroupName
  • Required: Yes
  • Type: string

The name of the managed node group to update.

scalingConfig
  • Type: NodegroupScalingConfig structure

The scaling configuration details for the Auto Scaling group after the update.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion|PublicAccessCidrs|AddonVersion|ServiceAccountRoleArn|ResolveConflicts',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AddonUpdate',
    ],
]

Result Details

Members
update
  • Type: Update structure

An object representing an asynchronous update.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ResourceInUseException:

    The specified resource is in use.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • InvalidRequestException:

    The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

UpdateNodegroupVersion

$result = $client->updateNodegroupVersion([/* ... */]);
$promise = $client->updateNodegroupVersionAsync([/* ... */]);

Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template.

If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.

You cannot roll back a node group to an earlier Kubernetes version or AMI version.

When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can force the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget issue.

Parameter Syntax

$result = $client->updateNodegroupVersion([
    'clientRequestToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'force' => true || false,
    'launchTemplate' => [
        'id' => '<string>',
        'name' => '<string>',
        'version' => '<string>',
    ],
    'nodegroupName' => '<string>', // REQUIRED
    'releaseVersion' => '<string>',
    'version' => '<string>',
]);

Parameter Details

Members
clientRequestToken
  • Type: string

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

clusterName
  • Required: Yes
  • Type: string

The name of the Amazon EKS cluster that is associated with the managed node group to update.

force
  • Type: boolean

Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.

launchTemplate
  • Type: LaunchTemplateSpecification structure

An object representing a node group's launch template specification. You can only update a node group using a launch template if the node group was originally deployed with a launch template.

nodegroupName
  • Required: Yes
  • Type: string

The name of the managed node group to update.

releaseVersion
  • Type: string

The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

version
  • Type: string

The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Result Syntax

[
    'update' => [
        'createdAt' => <DateTime>,
        'errors' => [
            [
                'errorCode' => 'SubnetNotFound|SecurityGroupNotFound|EniLimitReached|IpNotAvailable|AccessDenied|OperationNotPermitted|VpcIdNotFound|Unknown|NodeCreationFailure|PodEvictionFailure|InsufficientFreeAddresses|ClusterUnreachable|InsufficientNumberOfReplicas|ConfigurationConflict',
                'errorMessage' => '<string>',
                'resourceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'id' => '<string>',
        'params' => [
            [
                'type' => 'Version|PlatformVersion|EndpointPrivateAccess|EndpointPublicAccess|ClusterLogging|DesiredSize|LabelsToAdd|LabelsToRemove|MaxSize|MinSize|ReleaseVersion|PublicAccessCidrs|AddonVersion|ServiceAccountRoleArn|ResolveConflicts',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => 'InProgress|Failed|Cancelled|Successful',
        'type' => 'VersionUpdate|EndpointAccessUpdate|LoggingUpdate|ConfigUpdate|AddonUpdate',
    ],
]

Result Details

Members
update
  • Type: Update structure

An object representing an asynchronous update.

Errors

  • InvalidParameterException:

    The specified parameter is invalid. Review the available parameters for the API request.

  • ClientException:

    These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

  • ServerException:

    These errors are usually caused by a server-side issue.

  • ResourceInUseException:

    The specified resource is in use.

  • ResourceNotFoundException:

    The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

  • InvalidRequestException:

    The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

Shapes

Addon

Description

An Amazon EKS add-on.

Members
addonArn
  • Type: string

The Amazon Resource Name (ARN) of the add-on.

addonName
  • Type: string

The name of the add-on.

addonVersion
  • Type: string

The version of the add-on.

clusterName
  • Type: string

The name of the cluster.

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

The date and time that the add-on was created.

health
  • Type: AddonHealth structure

An object that represents the health of the add-on.

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

The date and time that the add-on was last modified.

serviceAccountRoleArn
  • Type: string

The Amazon Resource Name (ARN) of the IAM role that is bound to the Kubernetes service account used by the add-on.

status
  • Type: string

The status of the add-on.

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

The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.

AddonHealth

Description

The health of the add-on.

Members
issues
  • Type: Array of AddonIssue structures

An object that represents the add-on's health issues.

AddonInfo

Description

Information about an add-on.

Members
addonName
  • Type: string

The name of the add-on.

addonVersions
  • Type: Array of AddonVersionInfo structures

An object that represents information about available add-on versions and compatible Kubernetes versions.

type
  • Type: string

The type of the add-on.

AddonIssue

Description

An issue related to an add-on.

Members
code
  • Type: string

A code that describes the type of issue.

message
  • Type: string

A message that provides details about the issue and what might cause it.

resourceIds
  • Type: Array of strings

The resource IDs of the issue.

AddonVersionInfo

Description

Information about an add-on version.

Members
addonVersion
  • Type: string

The version of the add-on.

architecture
  • Type: Array of strings

The architectures that the version supports.

compatibilities
  • Type: Array of Compatibility structures

An object that represents the compatibilities of a version.

AutoScalingGroup

Description

An Auto Scaling group that is associated with an Amazon EKS managed node group.

Members
name
  • Type: string

The name of the Auto Scaling group associated with an Amazon EKS managed node group.

BadRequestException

Description

This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

Members
message
  • Type: string

Certificate

Description

An object representing the certificate-authority-data for your cluster.

Members
data
  • Type: string

The Base64-encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

ClientException

Description

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

Members
addonName
  • Type: string
clusterName
  • Type: string

The Amazon EKS cluster associated with the exception.

message
  • Type: string
nodegroupName
  • Type: string

The Amazon EKS managed node group associated with the exception.

Cluster

Description

An object representing an Amazon EKS cluster.

Members
arn
  • Type: string

The Amazon Resource Name (ARN) of the cluster.

certificateAuthority
  • Type: Certificate structure

The certificate-authority-data for your cluster.

clientRequestToken
  • Type: string

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

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

The Unix epoch timestamp in seconds for when the cluster was created.

encryptionConfig
  • Type: Array of EncryptionConfig structures

The encryption configuration for the cluster.

endpoint
  • Type: string

The endpoint for your Kubernetes API server.

identity
  • Type: Identity structure

The identity provider information for the cluster.

kubernetesNetworkConfig
  • Type: KubernetesNetworkConfigResponse structure

The Kubernetes network configuration for the cluster.

logging
  • Type: Logging structure

The logging configuration for your cluster.

name
  • Type: string

The name of the cluster.

platformVersion
  • Type: string

The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .

resourcesVpcConfig
  • Type: VpcConfigResponse structure

The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide.

roleArn
  • Type: string

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

status
  • Type: string

The current status of the cluster.

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

The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.

version
  • Type: string

The Kubernetes server version for the cluster.

Compatibility

Description

Compatibility information.

Members
clusterVersion
  • Type: string

The supported Kubernetes version of the cluster.

defaultVersion
  • Type: boolean

The supported default version.

platformVersions
  • Type: Array of strings

The supported compute platform.

EncryptionConfig

Description

The encryption configuration for the cluster.

Members
provider
  • Type: Provider structure

AWS Key Management Service (AWS KMS) customer master key (CMK). Either the ARN or the alias can be used.

resources
  • Type: Array of strings

Specifies the resources to be encrypted. The only supported value is "secrets".

ErrorDetail

Description

An object representing an error when an asynchronous operation fails.

Members
errorCode
  • Type: string

A brief description of the error.

  • SubnetNotFound: We couldn't find one of the subnets associated with the cluster.

  • SecurityGroupNotFound: We couldn't find one of the security groups associated with the cluster.

  • EniLimitReached: You have reached the elastic network interface limit for your account.

  • IpNotAvailable: A subnet associated with the cluster doesn't have any free IP addresses.

  • AccessDenied: You don't have permissions to perform the specified operation.

  • OperationNotPermitted: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS.

  • VpcIdNotFound: We couldn't find the VPC associated with the cluster.

errorMessage
  • Type: string

A more complete description of the error.

resourceIds
  • Type: Array of strings

An optional field that contains the resource IDs associated with the error.

FargateProfile

Description

An object representing an AWS Fargate profile.

Members
clusterName
  • Type: string

The name of the Amazon EKS cluster that the Fargate profile belongs to.

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

The Unix epoch timestamp in seconds for when the Fargate profile was created.

fargateProfileArn
  • Type: string

The full Amazon Resource Name (ARN) of the Fargate profile.

fargateProfileName
  • Type: string

The name of the Fargate profile.

podExecutionRoleArn
  • Type: string

The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. For more information, see Pod Execution Role in the Amazon EKS User Guide.

selectors
  • Type: Array of FargateProfileSelector structures

The selectors to match for pods to use this Fargate profile.

status
  • Type: string

The current status of the Fargate profile.

subnets
  • Type: Array of strings

The IDs of subnets to launch pods into.

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

The metadata applied to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.

FargateProfileSelector

Description

An object representing an AWS Fargate profile selector.

Members
labels
  • Type: Associative array of custom strings keys (String) to strings

The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match.

namespace
  • Type: string

The Kubernetes namespace that the selector should match.

Identity

Description

An object representing an identity provider for authentication credentials.

Members
oidc
  • Type: OIDC structure

The OpenID Connect identity provider information for the cluster.

InvalidParameterException

Description

The specified parameter is invalid. Review the available parameters for the API request.

Members
addonName
  • Type: string
clusterName
  • Type: string

The Amazon EKS cluster associated with the exception.

fargateProfileName
  • Type: string

The Fargate profile associated with the exception.

message
  • Type: string
nodegroupName
  • Type: string

The Amazon EKS managed node group associated with the exception.

InvalidRequestException

Description

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

Members
addonName
  • Type: string
clusterName
  • Type: string

The Amazon EKS cluster associated with the exception.

message
  • Type: string
nodegroupName
  • Type: string

The Amazon EKS managed node group associated with the exception.

Issue

Description

An object representing an issue with an Amazon EKS resource.

Members
code
  • Type: string

A brief description of the error.

  • AccessDenied: Amazon EKS or one or more of your managed nodes is failing to authenticate or authorize with your Kubernetes cluster API server.

  • AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch instances.

  • AutoScalingGroupNotFound: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover.

  • ClusterUnreachable: Amazon EKS or one or more of your managed nodes is unable to to communicate with your Kubernetes cluster API server. This can happen if there are network disruptions or if API servers are timing out processing requests.

  • Ec2LaunchTemplateNotFound: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover.

  • Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover.

  • Ec2SecurityGroupDeletionFailure: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group.

  • Ec2SecurityGroupNotFound: We couldn't find the cluster security group for the cluster. You must recreate your cluster.

  • Ec2SubnetInvalidConfiguration: One or more Amazon EC2 subnets specified for a node group do not automatically assign public IP addresses to instances launched into it. If you want your instances to be assigned a public IP address, then you need to enable the auto-assign public IP address setting for the subnet. See Modifying the public IPv4 addressing attribute for your subnet in the Amazon VPC User Guide.

  • IamInstanceProfileNotFound: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover.

  • IamNodeRoleNotFound: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover.

  • InstanceLimitExceeded: Your AWS account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover.

  • InsufficientFreeAddresses: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes.

  • InternalFailure: These errors are usually caused by an Amazon EKS server-side issue.

  • NodeCreationFailure: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient worker node IAM role permissions or lack of outbound internet access for the nodes.

message
  • Type: string

The error message associated with the issue.

resourceIds
  • Type: Array of strings

The AWS resources that are afflicted by this issue.

KubernetesNetworkConfigRequest

Description

The Kubernetes network configuration for the cluster.

Members
serviceIpv4Cidr
  • Type: string

The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. The block must meet the following requirements:

  • Within one of the following private IP address blocks: 10.0.0.0/8, 172.16.0.0.0/12, or 192.168.0.0/16.

  • Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC.

  • Between /24 and /12.

You can only specify a custom CIDR block when you create a cluster and can't change this value once the cluster is created.

KubernetesNetworkConfigResponse

Description

The Kubernetes network configuration for the cluster.

Members
serviceIpv4Cidr
  • Type: string

The CIDR block that Kubernetes service IP addresses are assigned from. If you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then it was specified when the cluster was created and it cannot be changed.

LaunchTemplateSpecification

Description

An object representing a node group launch template specification. The launch template cannot include SubnetId , IamInstanceProfile , RequestSpotInstances , HibernationOptions , or TerminateInstances , or the node group deployment or update will fail. For more information about launch templates, see CreateLaunchTemplate in the Amazon EC2 API Reference. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Specify either name or id, but not both.

Members
id
  • Type: string

The ID of the launch template.

name
  • Type: string

The name of the launch template.

version
  • Type: string

The version of the launch template to use. If no version is specified, then the template's default version is used.

LogSetup

Description

An object representing the enabled or disabled Kubernetes control plane logs for your cluster.

Members
enabled
  • Type: boolean

If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.

types
  • Type: Array of strings

The available cluster control plane log types.

Logging

Description

An object representing the logging configuration for resources in your cluster.

Members
clusterLogging
  • Type: Array of LogSetup structures

The cluster control plane logging configuration for your cluster.

Nodegroup

Description

An object representing an Amazon EKS managed node group.

Members
amiType
  • Type: string

If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM. For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration.

capacityType
  • Type: string

The capacity type of your managed node group.

clusterName
  • Type: string

The name of the cluster that the managed node group resides in.

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

The Unix epoch timestamp in seconds for when the managed node group was created.

diskSize
  • Type: int

If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is null.

health
  • Type: NodegroupHealth structure

The health status of the node group. If there are issues with your node group's health, they are listed here.

instanceTypes
  • Type: Array of strings

If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is null.

labels
  • Type: Associative array of custom strings keys (labelKey) to strings

The Kubernetes labels applied to the nodes in the node group.

Only labels that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels applied to the nodes in this group.

launchTemplate
  • Type: LaunchTemplateSpecification structure

If a launch template was used to create the node group, then this is the launch template that was used.

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

The Unix epoch timestamp in seconds for when the managed node group was last modified.

nodeRole
  • Type: string

The IAM role associated with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies.

nodegroupArn
  • Type: string

The Amazon Resource Name (ARN) associated with the managed node group.

nodegroupName
  • Type: string

The name associated with an Amazon EKS managed node group.

releaseVersion
  • Type: string

If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with.

remoteAccess
  • Type: RemoteAccessConfig structure

If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is null.

resources
  • Type: NodegroupResources structure

The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

scalingConfig
  • Type: NodegroupScalingConfig structure

The scaling configuration details for the Auto Scaling group that is associated with your node group.

status
  • Type: string

The current status of the managed node group.

subnets
  • Type: Array of strings

The subnets that were specified for the Auto Scaling group that is associated with your node group.

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

The metadata applied to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

version
  • Type: string

The Kubernetes version of the managed node group.

NodegroupHealth

Description

An object representing the health status of the node group.

Members
issues
  • Type: Array of Issue structures

Any issues that are associated with the node group.

NodegroupResources

Description

An object representing the resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

Members
autoScalingGroups
  • Type: Array of AutoScalingGroup structures

The Auto Scaling groups associated with the node group.

remoteAccessSecurityGroup
  • Type: string

The remote access security group associated with the node group. This security group controls SSH access to the worker nodes.

NodegroupScalingConfig

Description

An object representing the scaling configuration details for the Auto Scaling group that is associated with your node group. If you specify a value for any property, then you must specify values for all of the properties.

Members
desiredSize
  • Type: int

The current number of worker nodes that the managed node group should maintain.

maxSize
  • Type: int

The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default.

minSize
  • Type: int

The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than zero.

NotFoundException

Description

A service resource associated with the request could not be found. Clients should not retry such requests.

Members
message
  • Type: string

OIDC

Description

An object representing the OpenID Connect identity provider information for the cluster.

Members
issuer
  • Type: string

The issuer URL for the OpenID Connect identity provider.

Provider

Description

Identifies the AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the secrets.

Members
keyArn
  • Type: string

Amazon Resource Name (ARN) or alias of the customer master key (CMK). The CMK must be symmetric, created in the same region as the cluster, and if the CMK was created in a different account, the user must have access to the CMK. For more information, see Allowing Users in Other Accounts to Use a CMK in the AWS Key Management Service Developer Guide.

RemoteAccessConfig

Description

An object representing the remote access configuration for the managed node group.

Members
ec2SshKey
  • Type: string

The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

sourceSecurityGroups
  • Type: Array of strings

The security groups that are allowed SSH access (port 22) to the worker nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

ResourceInUseException

Description

The specified resource is in use.

Members
addonName
  • Type: string
clusterName
  • Type: string

The Amazon EKS cluster associated with the exception.

message
  • Type: string
nodegroupName
  • Type: string

The Amazon EKS managed node group associated with the exception.

ResourceLimitExceededException

Description

You have encountered a service limit on the specified resource.

Members
clusterName
  • Type: string

The Amazon EKS cluster associated with the exception.

message
  • Type: string
nodegroupName
  • Type: string

The Amazon EKS managed node group associated with the exception.

ResourceNotFoundException

Description

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

Members
addonName
  • Type: string
clusterName
  • Type: string

The Amazon EKS cluster associated with the exception.

fargateProfileName
  • Type: string

The Fargate profile associated with the exception.

message
  • Type: string
nodegroupName
  • Type: string

The Amazon EKS managed node group associated with the exception.

ServerException

Description

These errors are usually caused by a server-side issue.

Members
addonName
  • Type: string
clusterName
  • Type: string

The Amazon EKS cluster associated with the exception.

message
  • Type: string
nodegroupName
  • Type: string

The Amazon EKS managed node group associated with the exception.

ServiceUnavailableException

Description

The service is unavailable. Back off and retry the operation.

Members
message
  • Type: string

UnsupportedAvailabilityZoneException

Description

At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

Members
clusterName
  • Type: string

The Amazon EKS cluster associated with the exception.

message
  • Type: string
nodegroupName
  • Type: string

The Amazon EKS managed node group associated with the exception.

validZones
  • Type: Array of strings

The supported Availability Zones for your account. Choose subnets in these Availability Zones for your cluster.

Update

Description

An object representing an asynchronous update.

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

The Unix epoch timestamp in seconds for when the update was created.

errors
  • Type: Array of ErrorDetail structures

Any errors associated with a Failed update.

id
  • Type: string

A UUID that is used to track the update.

params
  • Type: Array of UpdateParam structures

A key-value map that contains the parameters associated with the update.

status
  • Type: string

The current status of the update.

type
  • Type: string

The type of the update.

UpdateLabelsPayload

Description

An object representing a Kubernetes label change for a managed node group.

Members
addOrUpdateLabels
  • Type: Associative array of custom strings keys (labelKey) to strings

Kubernetes labels to be added or updated.

removeLabels
  • Type: Array of strings

Kubernetes labels to be removed.

UpdateParam

Description

An object representing the details of an update request.

Members
type
  • Type: string

The keys associated with an update request.

value
  • Type: string

The value of the keys submitted as part of an update request.

VpcConfigRequest

Description

An object representing the VPC configuration to use for an Amazon EKS cluster.

Members
endpointPrivateAccess
  • Type: boolean

Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

endpointPublicAccess
  • Type: boolean

Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

publicAccessCidrs
  • Type: Array of strings

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

securityGroupIds
  • Type: Array of strings

Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes:

  • 1.14 Amazon EKS platform version eks.2 and earlier

  • 1.14 Amazon EKS platform version eks.3 and later

For more information, see Amazon EKS security group considerations in the Amazon EKS User Guide .

subnetIds
  • Type: Array of strings

Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane.

VpcConfigResponse

Description

An object representing an Amazon EKS cluster VPC configuration response.

Members
clusterSecurityGroupId
  • Type: string

The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.

endpointPrivateAccess
  • Type: boolean

This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have worker nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

endpointPublicAccess
  • Type: boolean

This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.

publicAccessCidrs
  • Type: Array of strings

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

securityGroupIds
  • Type: Array of strings

The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane.

subnetIds
  • Type: Array of strings

The subnets associated with your cluster.

vpcId
  • Type: string

The VPC associated with your cluster.

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