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

Namespaces

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

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Account\AccountClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • Aws\AmplifyUIBuilder\AmplifyUIBuilderClient
  • Aws\Api\AbstractModel
  • Aws\Api\ApiProvider
  • Aws\Api\DateTimeResult
  • Aws\Api\DocModel
  • Aws\Api\ErrorParser\AbstractErrorParser
  • Aws\Api\ErrorParser\JsonRpcErrorParser
  • Aws\Api\ErrorParser\RestJsonErrorParser
  • Aws\Api\ErrorParser\XmlErrorParser
  • Aws\Api\ListShape
  • Aws\Api\MapShape
  • Aws\Api\Operation
  • Aws\Api\Parser\Crc32ValidatingParser
  • Aws\Api\Parser\DecodingEventStreamIterator
  • Aws\Api\Parser\EventParsingIterator
  • Aws\Api\Parser\JsonParser
  • Aws\Api\Parser\JsonRpcParser
  • Aws\Api\Parser\QueryParser
  • Aws\Api\Parser\RestJsonParser
  • Aws\Api\Parser\RestXmlParser
  • Aws\Api\Parser\XmlParser
  • Aws\Api\Serializer\XmlBody
  • Aws\Api\Service
  • Aws\Api\Shape
  • Aws\Api\ShapeMap
  • Aws\Api\StructureShape
  • Aws\Api\TimestampShape
  • Aws\Api\Validator
  • Aws\ApiGateway\ApiGatewayClient
  • Aws\ApiGatewayManagementApi\ApiGatewayManagementApiClient
  • Aws\ApiGatewayV2\ApiGatewayV2Client
  • Aws\AppConfig\AppConfigClient
  • Aws\AppConfigData\AppConfigDataClient
  • Aws\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationCostProfiler\ApplicationCostProfilerClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • Aws\AppRunner\AppRunnerClient
  • Aws\Appstream\AppstreamClient
  • Aws\AppSync\AppSyncClient
  • Aws\ARCZonalShift\ARCZonalShiftClient
  • Aws\Athena\AthenaClient
  • Aws\AuditManager\AuditManagerClient
  • Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Backup\BackupClient
  • Aws\BackupGateway\BackupGatewayClient
  • Aws\BackupStorage\BackupStorageClient
  • Aws\Batch\BatchClient
  • Aws\BillingConductor\BillingConductorClient
  • Aws\Braket\BraketClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ChimeSDKIdentity\ChimeSDKIdentityClient
  • Aws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient
  • Aws\ChimeSDKMeetings\ChimeSDKMeetingsClient
  • Aws\ChimeSDKMessaging\ChimeSDKMessagingClient
  • Aws\ChimeSDKVoice\ChimeSDKVoiceClient
  • Aws\CleanRooms\CleanRoomsClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudControlApi\CloudControlApiClient
  • Aws\CloudDirectory\CloudDirectoryClient
  • Aws\CloudFormation\CloudFormationClient
  • Aws\CloudFront\CloudFrontClient
  • Aws\CloudFront\CookieSigner
  • Aws\CloudFront\UrlSigner
  • Aws\CloudHsm\CloudHsmClient
  • Aws\CloudHSMV2\CloudHSMV2Client
  • Aws\CloudSearch\CloudSearchClient
  • Aws\CloudSearchDomain\CloudSearchDomainClient
  • Aws\CloudTrail\CloudTrailClient
  • Aws\CloudTrail\LogFileIterator
  • Aws\CloudTrail\LogFileReader
  • Aws\CloudTrail\LogRecordIterator
  • Aws\CloudTrailData\CloudTrailDataClient
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchEvidently\CloudWatchEvidentlyClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CloudWatchRUM\CloudWatchRUMClient
  • Aws\CodeArtifact\CodeArtifactClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCatalyst\CodeCatalystClient
  • Aws\CodeCommit\CodeCommitClient
  • Aws\CodeDeploy\CodeDeployClient
  • Aws\CodeGuruProfiler\CodeGuruProfilerClient
  • Aws\CodeGuruReviewer\CodeGuruReviewerClient
  • Aws\CodePipeline\CodePipelineClient
  • Aws\CodeStar\CodeStarClient
  • Aws\CodeStarconnections\CodeStarconnectionsClient
  • Aws\CodeStarNotifications\CodeStarNotificationsClient
  • Aws\CognitoIdentity\CognitoIdentityClient
  • Aws\CognitoIdentity\CognitoIdentityProvider
  • Aws\CognitoIdentityProvider\CognitoIdentityProviderClient
  • Aws\CognitoSync\CognitoSyncClient
  • Aws\Command
  • Aws\CommandPool
  • Aws\Comprehend\ComprehendClient
  • Aws\ComprehendMedical\ComprehendMedicalClient
  • Aws\ComputeOptimizer\ComputeOptimizerClient
  • Aws\ConfigService\ConfigServiceClient
  • Aws\Connect\ConnectClient
  • Aws\ConnectCampaignService\ConnectCampaignServiceClient
  • Aws\ConnectCases\ConnectCasesClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\ConnectWisdomService\ConnectWisdomServiceClient
  • Aws\ControlTower\ControlTowerClient
  • Aws\CostandUsageReportService\CostandUsageReportServiceClient
  • Aws\CostExplorer\CostExplorerClient
  • Aws\Credentials\AssumeRoleCredentialProvider
  • Aws\Credentials\AssumeRoleWithWebIdentityCredentialProvider
  • Aws\Credentials\CredentialProvider
  • Aws\Credentials\Credentials
  • Aws\Credentials\EcsCredentialProvider
  • Aws\Credentials\InstanceProfileProvider
  • Aws\Crypto\AesDecryptingStream
  • Aws\Crypto\AesEncryptingStream
  • Aws\Crypto\AesGcmDecryptingStream
  • Aws\Crypto\AesGcmEncryptingStream
  • Aws\Crypto\Cipher\Cbc
  • Aws\Crypto\KmsMaterialsProvider
  • Aws\Crypto\KmsMaterialsProviderV2
  • Aws\Crypto\MaterialsProvider
  • Aws\Crypto\MaterialsProviderV2
  • Aws\Crypto\Polyfill\AesGcm
  • Aws\Crypto\Polyfill\ByteArray
  • Aws\Crypto\Polyfill\Gmac
  • Aws\Crypto\Polyfill\Key
  • Aws\CustomerProfiles\CustomerProfilesClient
  • Aws\DatabaseMigrationService\DatabaseMigrationServiceClient
  • Aws\DataExchange\DataExchangeClient
  • Aws\DataPipeline\DataPipelineClient
  • Aws\DataSync\DataSyncClient
  • Aws\DAX\DAXClient
  • Aws\DefaultsMode\Configuration
  • Aws\DefaultsMode\ConfigurationProvider
  • Aws\Detective\DetectiveClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DevOpsGuru\DevOpsGuruClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DocDBElastic\DocDBElasticClient
  • Aws\DoctrineCacheAdapter
  • Aws\drs\drsClient
  • Aws\DynamoDb\BinaryValue
  • Aws\DynamoDb\DynamoDbClient
  • Aws\DynamoDb\LockingSessionConnection
  • Aws\DynamoDb\Marshaler
  • Aws\DynamoDb\NumberValue
  • Aws\DynamoDb\SessionHandler
  • Aws\DynamoDb\SetValue
  • Aws\DynamoDb\StandardSessionConnection
  • Aws\DynamoDb\WriteRequestBatch
  • Aws\DynamoDbStreams\DynamoDbStreamsClient
  • Aws\EBS\EBSClient
  • Aws\Ec2\Ec2Client
  • Aws\EC2InstanceConnect\EC2InstanceConnectClient
  • Aws\Ecr\EcrClient
  • Aws\ECRPublic\ECRPublicClient
  • Aws\Ecs\EcsClient
  • Aws\Efs\EfsClient
  • Aws\EKS\EKSClient
  • Aws\ElastiCache\ElastiCacheClient
  • Aws\ElasticBeanstalk\ElasticBeanstalkClient
  • Aws\ElasticInference\ElasticInferenceClient
  • Aws\ElasticLoadBalancing\ElasticLoadBalancingClient
  • Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client
  • Aws\ElasticsearchService\ElasticsearchServiceClient
  • Aws\ElasticTranscoder\ElasticTranscoderClient
  • Aws\Emr\EmrClient
  • Aws\EMRContainers\EMRContainersClient
  • Aws\EMRServerless\EMRServerlessClient
  • Aws\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\Endpoint\UseDualstackEndpoint\Configuration
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationProvider
  • Aws\Endpoint\UseFipsEndpoint\Configuration
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EndpointV2\EndpointDefinitionProvider
  • Aws\EndpointV2\EndpointProviderV2
  • Aws\EndpointV2\Rule\AbstractRule
  • Aws\EndpointV2\Rule\EndpointRule
  • Aws\EndpointV2\Rule\ErrorRule
  • Aws\EndpointV2\Rule\RuleCreator
  • Aws\EndpointV2\Rule\TreeRule
  • Aws\EndpointV2\Ruleset\Ruleset
  • Aws\EndpointV2\Ruleset\RulesetEndpoint
  • Aws\EndpointV2\Ruleset\RulesetParameter
  • Aws\EventBridge\EventBridgeClient
  • Aws\finspace\finspaceClient
  • Aws\FinSpaceData\FinSpaceDataClient
  • Aws\Firehose\FirehoseClient
  • Aws\FIS\FISClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FraudDetector\FraudDetectorClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • Aws\GameSparks\GameSparksClient
  • Aws\Glacier\GlacierClient
  • Aws\Glacier\MultipartUploader
  • Aws\Glacier\TreeHash
  • Aws\GlobalAccelerator\GlobalAcceleratorClient
  • Aws\Glue\GlueClient
  • Aws\GlueDataBrew\GlueDataBrewClient
  • Aws\Greengrass\GreengrassClient
  • Aws\GreengrassV2\GreengrassV2Client
  • Aws\GroundStation\GroundStationClient
  • Aws\GuardDuty\GuardDutyClient
  • Aws\Handler\GuzzleV5\GuzzleHandler
  • Aws\Handler\GuzzleV5\GuzzleStream
  • Aws\Handler\GuzzleV5\PsrStream
  • Aws\Handler\GuzzleV6\GuzzleHandler
  • Aws\HandlerList
  • Aws\HashingStream
  • Aws\Health\HealthClient
  • Aws\HealthLake\HealthLakeClient
  • Aws\History
  • Aws\Honeycode\HoneycodeClient
  • Aws\Iam\IamClient
  • Aws\IdempotencyTokenMiddleware
  • Aws\IdentityStore\IdentityStoreClient
  • Aws\imagebuilder\imagebuilderClient
  • Aws\ImportExport\ImportExportClient
  • Aws\Inspector2\Inspector2Client
  • Aws\Inspector\InspectorClient
  • Aws\InternetMonitor\InternetMonitorClient
  • Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient
  • Aws\IoT1ClickProjects\IoT1ClickProjectsClient
  • Aws\Iot\IotClient
  • Aws\IoTAnalytics\IoTAnalyticsClient
  • Aws\IotDataPlane\IotDataPlaneClient
  • Aws\IoTDeviceAdvisor\IoTDeviceAdvisorClient
  • Aws\IoTEvents\IoTEventsClient
  • Aws\IoTEventsData\IoTEventsDataClient
  • Aws\IoTFleetHub\IoTFleetHubClient
  • Aws\IoTFleetWise\IoTFleetWiseClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTRoboRunner\IoTRoboRunnerClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTSiteWise\IoTSiteWiseClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\IoTTwinMaker\IoTTwinMakerClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\ivschat\ivschatClient
  • Aws\IVSRealTime\IVSRealTimeClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\KafkaConnect\KafkaConnectClient
  • Aws\kendra\kendraClient
  • Aws\KendraRanking\KendraRankingClient
  • Aws\Keyspaces\KeyspacesClient
  • Aws\Kinesis\KinesisClient
  • Aws\KinesisAnalytics\KinesisAnalyticsClient
  • Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client
  • Aws\KinesisVideo\KinesisVideoClient
  • Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
  • Aws\KinesisVideoMedia\KinesisVideoMediaClient
  • Aws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient
  • Aws\KinesisVideoWebRTCStorage\KinesisVideoWebRTCStorageClient
  • Aws\Kms\KmsClient
  • Aws\LakeFormation\LakeFormationClient
  • Aws\Lambda\LambdaClient
  • Aws\LexModelBuildingService\LexModelBuildingServiceClient
  • Aws\LexModelsV2\LexModelsV2Client
  • Aws\LexRuntimeService\LexRuntimeServiceClient
  • Aws\LexRuntimeV2\LexRuntimeV2Client
  • Aws\LicenseManager\LicenseManagerClient
  • Aws\LicenseManagerLinuxSubscriptions\LicenseManagerLinuxSubscriptionsClient
  • Aws\LicenseManagerUserSubscriptions\LicenseManagerUserSubscriptionsClient
  • Aws\Lightsail\LightsailClient
  • Aws\LocationService\LocationServiceClient
  • Aws\LookoutEquipment\LookoutEquipmentClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LookoutMetrics\LookoutMetricsClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie2\Macie2Client
  • Aws\Macie\MacieClient
  • Aws\MainframeModernization\MainframeModernizationClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • Aws\ManagedGrafana\ManagedGrafanaClient
  • Aws\MarketplaceCatalog\MarketplaceCatalogClient
  • Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient
  • Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient
  • Aws\MarketplaceMetering\MarketplaceMeteringClient
  • Aws\MediaConnect\MediaConnectClient
  • Aws\MediaConvert\MediaConvertClient
  • Aws\MediaLive\MediaLiveClient
  • Aws\MediaPackage\MediaPackageClient
  • Aws\MediaPackageVod\MediaPackageVodClient
  • Aws\MediaStore\MediaStoreClient
  • Aws\MediaStoreData\MediaStoreDataClient
  • Aws\MediaTailor\MediaTailorClient
  • Aws\MemoryDB\MemoryDBClient
  • Aws\mgn\mgnClient
  • Aws\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • Aws\MigrationHubOrchestrator\MigrationHubOrchestratorClient
  • Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient
  • Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient
  • Aws\Mobile\MobileClient
  • Aws\MockHandler
  • Aws\MQ\MQClient
  • Aws\MTurk\MTurkClient
  • Aws\Multipart\UploadState
  • Aws\MultiRegionClient
  • Aws\MWAA\MWAAClient
  • Aws\Neptune\NeptuneClient
  • Aws\NetworkFirewall\NetworkFirewallClient
  • Aws\NetworkManager\NetworkManagerClient
  • Aws\NimbleStudio\NimbleStudioClient
  • Aws\OAM\OAMClient
  • Aws\Omics\OmicsClient
  • Aws\OpenSearchServerless\OpenSearchServerlessClient
  • Aws\OpenSearchService\OpenSearchServiceClient
  • Aws\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Outposts\OutpostsClient
  • Aws\Panorama\PanoramaClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client
  • Aws\Pipes\PipesClient
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrivateNetworks\PrivateNetworksClient
  • Aws\PrometheusService\PrometheusServiceClient
  • Aws\Proton\ProtonClient
  • Aws\Psr16CacheAdapter
  • Aws\PsrCacheAdapter
  • Aws\QLDB\QLDBClient
  • Aws\QLDBSession\QLDBSessionClient
  • Aws\QuickSight\QuickSightClient
  • Aws\RAM\RAMClient
  • Aws\Rds\AuthTokenGenerator
  • Aws\Rds\RdsClient
  • Aws\RDSDataService\RDSDataServiceClient
  • Aws\RecycleBin\RecycleBinClient
  • Aws\Redshift\RedshiftClient
  • Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
  • Aws\RedshiftServerless\RedshiftServerlessClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResilienceHub\ResilienceHubClient
  • Aws\ResourceExplorer2\ResourceExplorer2Client
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\Retry\Configuration
  • Aws\Retry\ConfigurationProvider
  • Aws\RoboMaker\RoboMakerClient
  • Aws\RolesAnywhere\RolesAnywhereClient
  • Aws\Route53\Route53Client
  • Aws\Route53Domains\Route53DomainsClient
  • Aws\Route53RecoveryCluster\Route53RecoveryClusterClient
  • Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient
  • Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient
  • Aws\Route53Resolver\Route53ResolverClient
  • Aws\S3\BatchDelete
  • Aws\S3\Crypto\HeadersMetadataStrategy
  • Aws\S3\Crypto\InstructionFileMetadataStrategy
  • Aws\S3\Crypto\S3EncryptionClient
  • Aws\S3\Crypto\S3EncryptionClientV2
  • Aws\S3\Crypto\S3EncryptionMultipartUploader
  • Aws\S3\Crypto\S3EncryptionMultipartUploaderV2
  • Aws\S3\GetBucketLocationParser
  • Aws\S3\MultipartUploader
  • Aws\S3\ObjectCopier
  • Aws\S3\ObjectUploader
  • Aws\S3\PostObject
  • Aws\S3\PostObjectV4
  • Aws\S3\RegionalEndpoint\Configuration
  • Aws\S3\RegionalEndpoint\ConfigurationProvider
  • Aws\S3\S3Client
  • Aws\S3\S3MultiRegionClient
  • Aws\S3\S3UriParser
  • Aws\S3\StreamWrapper
  • Aws\S3\Transfer
  • Aws\S3\UseArnRegion\Configuration
  • Aws\S3\UseArnRegion\ConfigurationProvider
  • Aws\S3\ValidateResponseChecksumParser
  • Aws\S3Control\S3ControlClient
  • Aws\S3Outposts\S3OutpostsClient
  • Aws\SageMaker\SageMakerClient
  • Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient
  • Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
  • Aws\SageMakerGeospatial\SageMakerGeospatialClient
  • Aws\SageMakerMetrics\SageMakerMetricsClient
  • Aws\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\SavingsPlans\SavingsPlansClient
  • Aws\Scheduler\SchedulerClient
  • Aws\Schemas\SchemasClient
  • Aws\Script\Composer\Composer
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\SecurityHub\SecurityHubClient
  • Aws\SecurityLake\SecurityLakeClient
  • Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
  • Aws\ServiceCatalog\ServiceCatalogClient
  • Aws\ServiceDiscovery\ServiceDiscoveryClient
  • Aws\ServiceQuotas\ServiceQuotasClient
  • Aws\Ses\SesClient
  • Aws\SesV2\SesV2Client
  • Aws\Sfn\SfnClient
  • Aws\Shield\ShieldClient
  • Aws\Signature\AnonymousSignature
  • Aws\Signature\S3SignatureV4
  • Aws\Signature\SignatureProvider
  • Aws\Signature\SignatureV4
  • Aws\signer\signerClient
  • Aws\SimSpaceWeaver\SimSpaceWeaverClient
  • Aws\Sms\SmsClient
  • Aws\SnowBall\SnowBallClient
  • Aws\SnowDeviceManagement\SnowDeviceManagementClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSMContacts\SSMContactsClient
  • Aws\SSMIncidents\SSMIncidentsClient
  • Aws\SsmSap\SsmSapClient
  • Aws\SSO\SSOClient
  • Aws\SSOAdmin\SSOAdminClient
  • Aws\SSOOIDC\SSOOIDCClient
  • Aws\StorageGateway\StorageGatewayClient
  • Aws\Sts\RegionalEndpoints\Configuration
  • Aws\Sts\RegionalEndpoints\ConfigurationProvider
  • Aws\Sts\StsClient
  • Aws\Support\SupportClient
  • Aws\SupportApp\SupportAppClient
  • Aws\Swf\SwfClient
  • Aws\Synthetics\SyntheticsClient
  • Aws\Textract\TextractClient
  • Aws\TimestreamQuery\TimestreamQueryClient
  • Aws\TimestreamWrite\TimestreamWriteClient
  • Aws\Tnb\TnbClient
  • Aws\Token\BearerTokenAuthorization
  • Aws\Token\SsoToken
  • Aws\Token\SsoTokenProvider
  • Aws\Token\Token
  • Aws\Token\TokenProvider
  • Aws\TraceMiddleware
  • Aws\TranscribeService\TranscribeServiceClient
  • Aws\Transfer\TransferClient
  • Aws\Translate\TranslateClient
  • Aws\VoiceID\VoiceIDClient
  • Aws\Waf\WafClient
  • Aws\WafRegional\WafRegionalClient
  • Aws\WAFV2\WAFV2Client
  • Aws\Waiter
  • Aws\WellArchitected\WellArchitectedClient
  • Aws\WorkDocs\WorkDocsClient
  • Aws\WorkLink\WorkLinkClient
  • Aws\WorkMail\WorkMailClient
  • Aws\WorkMailMessageFlow\WorkMailMessageFlowClient
  • Aws\WorkSpaces\WorkSpacesClient
  • Aws\WorkSpacesWeb\WorkSpacesWebClient
  • Aws\WrappedHttpHandler
  • Aws\XRay\XRayClient

Interfaces

  • Aws\AwsClientInterface
  • Aws\CacheInterface
  • Aws\ClientSideMonitoring\ConfigurationInterface
  • Aws\CommandInterface
  • Aws\ConfigurationProviderInterface
  • Aws\Credentials\CredentialsInterface
  • Aws\Crypto\AesStreamInterface
  • Aws\Crypto\AesStreamInterfaceV2
  • Aws\Crypto\Cipher\CipherMethod
  • Aws\Crypto\MaterialsProviderInterface
  • Aws\Crypto\MaterialsProviderInterfaceV2
  • Aws\Crypto\MetadataStrategyInterface
  • Aws\DefaultsMode\ConfigurationInterface
  • Aws\DynamoDb\SessionConnectionInterface
  • Aws\Endpoint\PartitionInterface
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationInterface
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationInterface
  • Aws\EndpointDiscovery\ConfigurationInterface
  • Aws\HashInterface
  • Aws\MonitoringEventsInterface
  • Aws\ResponseContainerInterface
  • Aws\ResultInterface
  • Aws\Retry\ConfigurationInterface
  • Aws\S3\RegionalEndpoint\ConfigurationInterface
  • Aws\S3\S3ClientInterface
  • Aws\S3\UseArnRegion\ConfigurationInterface
  • Aws\Signature\SignatureInterface
  • Aws\Sts\RegionalEndpoints\ConfigurationInterface
  • Aws\Token\RefreshableTokenProviderInterface
  • Aws\Token\TokenAuthorization
  • Aws\Token\TokenInterface

Traits

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

Exceptions

  • Aws\AccessAnalyzer\Exception\AccessAnalyzerException
  • Aws\Account\Exception\AccountException
  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\AmplifyBackend\Exception\AmplifyBackendException
  • Aws\AmplifyUIBuilder\Exception\AmplifyUIBuilderException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\AppConfigData\Exception\AppConfigDataException
  • Aws\Appflow\Exception\AppflowException
  • Aws\AppIntegrationsService\Exception\AppIntegrationsServiceException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationCostProfiler\Exception\ApplicationCostProfilerException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\AppRegistry\Exception\AppRegistryException
  • Aws\AppRunner\Exception\AppRunnerException
  • Aws\Appstream\Exception\AppstreamException
  • Aws\AppSync\Exception\AppSyncException
  • Aws\ARCZonalShift\Exception\ARCZonalShiftException
  • Aws\Arn\Exception\InvalidArnException
  • Aws\Athena\Exception\AthenaException
  • Aws\AuditManager\Exception\AuditManagerException
  • Aws\AugmentedAIRuntime\Exception\AugmentedAIRuntimeException
  • Aws\AutoScaling\Exception\AutoScalingException
  • Aws\AutoScalingPlans\Exception\AutoScalingPlansException
  • Aws\Backup\Exception\BackupException
  • Aws\BackupGateway\Exception\BackupGatewayException
  • Aws\BackupStorage\Exception\BackupStorageException
  • Aws\Batch\Exception\BatchException
  • Aws\BillingConductor\Exception\BillingConductorException
  • Aws\Braket\Exception\BraketException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ChimeSDKIdentity\Exception\ChimeSDKIdentityException
  • Aws\ChimeSDKMediaPipelines\Exception\ChimeSDKMediaPipelinesException
  • Aws\ChimeSDKMeetings\Exception\ChimeSDKMeetingsException
  • Aws\ChimeSDKMessaging\Exception\ChimeSDKMessagingException
  • Aws\ChimeSDKVoice\Exception\ChimeSDKVoiceException
  • Aws\CleanRooms\Exception\CleanRoomsException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • Aws\Cloud9\Exception\Cloud9Exception
  • Aws\CloudControlApi\Exception\CloudControlApiException
  • Aws\CloudDirectory\Exception\CloudDirectoryException
  • Aws\CloudFormation\Exception\CloudFormationException
  • Aws\CloudFront\Exception\CloudFrontException
  • Aws\CloudHsm\Exception\CloudHsmException
  • Aws\CloudHSMV2\Exception\CloudHSMV2Exception
  • Aws\CloudSearch\Exception\CloudSearchException
  • Aws\CloudSearchDomain\Exception\CloudSearchDomainException
  • Aws\CloudTrail\Exception\CloudTrailException
  • Aws\CloudTrailData\Exception\CloudTrailDataException
  • Aws\CloudWatch\Exception\CloudWatchException
  • Aws\CloudWatchEvents\Exception\CloudWatchEventsException
  • Aws\CloudWatchEvidently\Exception\CloudWatchEvidentlyException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CloudWatchRUM\Exception\CloudWatchRUMException
  • Aws\CodeArtifact\Exception\CodeArtifactException
  • Aws\CodeBuild\Exception\CodeBuildException
  • Aws\CodeCatalyst\Exception\CodeCatalystException
  • Aws\CodeCommit\Exception\CodeCommitException
  • Aws\CodeDeploy\Exception\CodeDeployException
  • Aws\CodeGuruProfiler\Exception\CodeGuruProfilerException
  • Aws\CodeGuruReviewer\Exception\CodeGuruReviewerException
  • Aws\CodePipeline\Exception\CodePipelineException
  • Aws\CodeStar\Exception\CodeStarException
  • Aws\CodeStarconnections\Exception\CodeStarconnectionsException
  • Aws\CodeStarNotifications\Exception\CodeStarNotificationsException
  • Aws\CognitoIdentity\Exception\CognitoIdentityException
  • Aws\CognitoIdentityProvider\Exception\CognitoIdentityProviderException
  • Aws\CognitoSync\Exception\CognitoSyncException
  • Aws\Comprehend\Exception\ComprehendException
  • Aws\ComprehendMedical\Exception\ComprehendMedicalException
  • Aws\ComputeOptimizer\Exception\ComputeOptimizerException
  • Aws\ConfigService\Exception\ConfigServiceException
  • Aws\Connect\Exception\ConnectException
  • Aws\ConnectCampaignService\Exception\ConnectCampaignServiceException
  • Aws\ConnectCases\Exception\ConnectCasesException
  • Aws\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\ConnectWisdomService\Exception\ConnectWisdomServiceException
  • Aws\ControlTower\Exception\ControlTowerException
  • Aws\CostandUsageReportService\Exception\CostandUsageReportServiceException
  • Aws\CostExplorer\Exception\CostExplorerException
  • Aws\CustomerProfiles\Exception\CustomerProfilesException
  • Aws\DatabaseMigrationService\Exception\DatabaseMigrationServiceException
  • Aws\DataExchange\Exception\DataExchangeException
  • Aws\DataPipeline\Exception\DataPipelineException
  • Aws\DataSync\Exception\DataSyncException
  • Aws\DAX\Exception\DAXException
  • Aws\DefaultsMode\Exception\ConfigurationException
  • Aws\Detective\Exception\DetectiveException
  • Aws\DeviceFarm\Exception\DeviceFarmException
  • Aws\DevOpsGuru\Exception\DevOpsGuruException
  • Aws\DirectConnect\Exception\DirectConnectException
  • Aws\DirectoryService\Exception\DirectoryServiceException
  • Aws\DLM\Exception\DLMException
  • Aws\DocDB\Exception\DocDBException
  • Aws\DocDBElastic\Exception\DocDBElasticException
  • Aws\drs\Exception\drsException
  • Aws\DynamoDb\Exception\DynamoDbException
  • Aws\DynamoDbStreams\Exception\DynamoDbStreamsException
  • Aws\EBS\Exception\EBSException
  • Aws\Ec2\Exception\Ec2Exception
  • Aws\EC2InstanceConnect\Exception\EC2InstanceConnectException
  • Aws\Ecr\Exception\EcrException
  • Aws\ECRPublic\Exception\ECRPublicException
  • Aws\Ecs\Exception\EcsException
  • Aws\Efs\Exception\EfsException
  • Aws\EKS\Exception\EKSException
  • Aws\ElastiCache\Exception\ElastiCacheException
  • Aws\ElasticBeanstalk\Exception\ElasticBeanstalkException
  • Aws\ElasticInference\Exception\ElasticInferenceException
  • Aws\ElasticLoadBalancing\Exception\ElasticLoadBalancingException
  • Aws\ElasticLoadBalancingV2\Exception\ElasticLoadBalancingV2Exception
  • Aws\ElasticsearchService\Exception\ElasticsearchServiceException
  • Aws\ElasticTranscoder\Exception\ElasticTranscoderException
  • Aws\Emr\Exception\EmrException
  • Aws\EMRContainers\Exception\EMRContainersException
  • Aws\EMRServerless\Exception\EMRServerlessException
  • Aws\Endpoint\UseDualstackEndpoint\Exception\ConfigurationException
  • Aws\Endpoint\UseFipsEndpoint\Exception\ConfigurationException
  • Aws\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • Aws\Exception\CommonRuntimeException
  • Aws\Exception\CouldNotCreateChecksumException
  • Aws\Exception\CredentialsException
  • Aws\Exception\CryptoException
  • Aws\Exception\CryptoPolyfillException
  • Aws\Exception\EventStreamDataException
  • Aws\Exception\IncalculablePayloadException
  • Aws\Exception\InvalidJsonException
  • Aws\Exception\InvalidRegionException
  • Aws\Exception\MultipartUploadException
  • Aws\Exception\TokenException
  • Aws\Exception\UnresolvedApiException
  • Aws\Exception\UnresolvedEndpointException
  • Aws\Exception\UnresolvedSignatureException
  • Aws\finspace\Exception\finspaceException
  • Aws\FinSpaceData\Exception\FinSpaceDataException
  • Aws\Firehose\Exception\FirehoseException
  • Aws\FIS\Exception\FISException
  • Aws\FMS\Exception\FMSException
  • Aws\ForecastQueryService\Exception\ForecastQueryServiceException
  • Aws\ForecastService\Exception\ForecastServiceException
  • Aws\FraudDetector\Exception\FraudDetectorException
  • Aws\FSx\Exception\FSxException
  • Aws\GameLift\Exception\GameLiftException
  • Aws\GameSparks\Exception\GameSparksException
  • Aws\Glacier\Exception\GlacierException
  • Aws\GlobalAccelerator\Exception\GlobalAcceleratorException
  • Aws\Glue\Exception\GlueException
  • Aws\GlueDataBrew\Exception\GlueDataBrewException
  • Aws\Greengrass\Exception\GreengrassException
  • Aws\GreengrassV2\Exception\GreengrassV2Exception
  • Aws\GroundStation\Exception\GroundStationException
  • Aws\GuardDuty\Exception\GuardDutyException
  • Aws\Health\Exception\HealthException
  • Aws\HealthLake\Exception\HealthLakeException
  • Aws\Honeycode\Exception\HoneycodeException
  • Aws\Iam\Exception\IamException
  • Aws\IdentityStore\Exception\IdentityStoreException
  • Aws\imagebuilder\Exception\imagebuilderException
  • Aws\ImportExport\Exception\ImportExportException
  • Aws\Inspector2\Exception\Inspector2Exception
  • Aws\Inspector\Exception\InspectorException
  • Aws\InternetMonitor\Exception\InternetMonitorException
  • Aws\IoT1ClickDevicesService\Exception\IoT1ClickDevicesServiceException
  • Aws\IoT1ClickProjects\Exception\IoT1ClickProjectsException
  • Aws\Iot\Exception\IotException
  • Aws\IoTAnalytics\Exception\IoTAnalyticsException
  • Aws\IotDataPlane\Exception\IotDataPlaneException
  • Aws\IoTDeviceAdvisor\Exception\IoTDeviceAdvisorException
  • Aws\IoTEvents\Exception\IoTEventsException
  • Aws\IoTEventsData\Exception\IoTEventsDataException
  • Aws\IoTFleetHub\Exception\IoTFleetHubException
  • Aws\IoTFleetWise\Exception\IoTFleetWiseException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTRoboRunner\Exception\IoTRoboRunnerException
  • Aws\IoTSecureTunneling\Exception\IoTSecureTunnelingException
  • Aws\IoTSiteWise\Exception\IoTSiteWiseException
  • Aws\IoTThingsGraph\Exception\IoTThingsGraphException
  • Aws\IoTTwinMaker\Exception\IoTTwinMakerException
  • Aws\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\ivschat\Exception\ivschatException
  • Aws\IVSRealTime\Exception\IVSRealTimeException
  • Aws\Kafka\Exception\KafkaException
  • Aws\KafkaConnect\Exception\KafkaConnectException
  • Aws\kendra\Exception\kendraException
  • Aws\KendraRanking\Exception\KendraRankingException
  • Aws\Keyspaces\Exception\KeyspacesException
  • Aws\Kinesis\Exception\KinesisException
  • Aws\KinesisAnalytics\Exception\KinesisAnalyticsException
  • Aws\KinesisAnalyticsV2\Exception\KinesisAnalyticsV2Exception
  • Aws\KinesisVideo\Exception\KinesisVideoException
  • Aws\KinesisVideoArchivedMedia\Exception\KinesisVideoArchivedMediaException
  • Aws\KinesisVideoMedia\Exception\KinesisVideoMediaException
  • Aws\KinesisVideoSignalingChannels\Exception\KinesisVideoSignalingChannelsException
  • Aws\KinesisVideoWebRTCStorage\Exception\KinesisVideoWebRTCStorageException
  • Aws\Kms\Exception\KmsException
  • Aws\LakeFormation\Exception\LakeFormationException
  • Aws\Lambda\Exception\LambdaException
  • Aws\LexModelBuildingService\Exception\LexModelBuildingServiceException
  • Aws\LexModelsV2\Exception\LexModelsV2Exception
  • Aws\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\LexRuntimeV2\Exception\LexRuntimeV2Exception
  • Aws\LicenseManager\Exception\LicenseManagerException
  • Aws\LicenseManagerLinuxSubscriptions\Exception\LicenseManagerLinuxSubscriptionsException
  • Aws\LicenseManagerUserSubscriptions\Exception\LicenseManagerUserSubscriptionsException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\LocationService\Exception\LocationServiceException
  • Aws\LookoutEquipment\Exception\LookoutEquipmentException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\LookoutMetrics\Exception\LookoutMetricsException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie2\Exception\Macie2Exception
  • Aws\Macie\Exception\MacieException
  • Aws\MainframeModernization\Exception\MainframeModernizationException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • Aws\ManagedGrafana\Exception\ManagedGrafanaException
  • Aws\MarketplaceCatalog\Exception\MarketplaceCatalogException
  • Aws\MarketplaceCommerceAnalytics\Exception\MarketplaceCommerceAnalyticsException
  • Aws\MarketplaceEntitlementService\Exception\MarketplaceEntitlementServiceException
  • Aws\MarketplaceMetering\Exception\MarketplaceMeteringException
  • Aws\MediaConnect\Exception\MediaConnectException
  • Aws\MediaConvert\Exception\MediaConvertException
  • Aws\MediaLive\Exception\MediaLiveException
  • Aws\MediaPackage\Exception\MediaPackageException
  • Aws\MediaPackageVod\Exception\MediaPackageVodException
  • Aws\MediaStore\Exception\MediaStoreException
  • Aws\MediaStoreData\Exception\MediaStoreDataException
  • Aws\MediaTailor\Exception\MediaTailorException
  • Aws\MemoryDB\Exception\MemoryDBException
  • Aws\mgn\Exception\mgnException
  • Aws\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • Aws\MigrationHubOrchestrator\Exception\MigrationHubOrchestratorException
  • Aws\MigrationHubRefactorSpaces\Exception\MigrationHubRefactorSpacesException
  • Aws\MigrationHubStrategyRecommendations\Exception\MigrationHubStrategyRecommendationsException
  • Aws\Mobile\Exception\MobileException
  • Aws\MQ\Exception\MQException
  • Aws\MTurk\Exception\MTurkException
  • Aws\MWAA\Exception\MWAAException
  • Aws\Neptune\Exception\NeptuneException
  • Aws\NetworkFirewall\Exception\NetworkFirewallException
  • Aws\NetworkManager\Exception\NetworkManagerException
  • Aws\NimbleStudio\Exception\NimbleStudioException
  • Aws\OAM\Exception\OAMException
  • Aws\Omics\Exception\OmicsException
  • Aws\OpenSearchServerless\Exception\OpenSearchServerlessException
  • Aws\OpenSearchService\Exception\OpenSearchServiceException
  • Aws\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Outposts\Exception\OutpostsException
  • Aws\Panorama\Exception\PanoramaException
  • Aws\Personalize\Exception\PersonalizeException
  • Aws\PersonalizeEvents\Exception\PersonalizeEventsException
  • Aws\PersonalizeRuntime\Exception\PersonalizeRuntimeException
  • Aws\PI\Exception\PIException
  • Aws\Pinpoint\Exception\PinpointException
  • Aws\PinpointEmail\Exception\PinpointEmailException
  • Aws\PinpointSMSVoice\Exception\PinpointSMSVoiceException
  • Aws\PinpointSMSVoiceV2\Exception\PinpointSMSVoiceV2Exception
  • Aws\Pipes\Exception\PipesException
  • Aws\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\PrivateNetworks\Exception\PrivateNetworksException
  • Aws\PrometheusService\Exception\PrometheusServiceException
  • Aws\Proton\Exception\ProtonException
  • Aws\QLDB\Exception\QLDBException
  • Aws\QLDBSession\Exception\QLDBSessionException
  • Aws\QuickSight\Exception\QuickSightException
  • Aws\RAM\Exception\RAMException
  • Aws\Rds\Exception\RdsException
  • Aws\RDSDataService\Exception\RDSDataServiceException
  • Aws\RecycleBin\Exception\RecycleBinException
  • Aws\Redshift\Exception\RedshiftException
  • Aws\RedshiftDataAPIService\Exception\RedshiftDataAPIServiceException
  • Aws\RedshiftServerless\Exception\RedshiftServerlessException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResilienceHub\Exception\ResilienceHubException
  • Aws\ResourceExplorer2\Exception\ResourceExplorer2Exception
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\Retry\Exception\ConfigurationException
  • Aws\RoboMaker\Exception\RoboMakerException
  • Aws\RolesAnywhere\Exception\RolesAnywhereException
  • Aws\Route53\Exception\Route53Exception
  • Aws\Route53Domains\Exception\Route53DomainsException
  • Aws\Route53RecoveryCluster\Exception\Route53RecoveryClusterException
  • Aws\Route53RecoveryControlConfig\Exception\Route53RecoveryControlConfigException
  • Aws\Route53RecoveryReadiness\Exception\Route53RecoveryReadinessException
  • Aws\Route53Resolver\Exception\Route53ResolverException
  • Aws\S3\Exception\DeleteMultipleObjectsException
  • Aws\S3\Exception\PermanentRedirectException
  • Aws\S3\Exception\S3Exception
  • Aws\S3\Exception\S3MultipartUploadException
  • Aws\S3\RegionalEndpoint\Exception\ConfigurationException
  • Aws\S3\UseArnRegion\Exception\ConfigurationException
  • Aws\S3Control\Exception\S3ControlException
  • Aws\S3Outposts\Exception\S3OutpostsException
  • Aws\SageMaker\Exception\SageMakerException
  • Aws\SagemakerEdgeManager\Exception\SagemakerEdgeManagerException
  • Aws\SageMakerFeatureStoreRuntime\Exception\SageMakerFeatureStoreRuntimeException
  • Aws\SageMakerGeospatial\Exception\SageMakerGeospatialException
  • Aws\SageMakerMetrics\Exception\SageMakerMetricsException
  • Aws\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SavingsPlans\Exception\SavingsPlansException
  • Aws\Scheduler\Exception\SchedulerException
  • Aws\Schemas\Exception\SchemasException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\SecurityHub\Exception\SecurityHubException
  • Aws\SecurityLake\Exception\SecurityLakeException
  • Aws\ServerlessApplicationRepository\Exception\ServerlessApplicationRepositoryException
  • Aws\ServiceCatalog\Exception\ServiceCatalogException
  • Aws\ServiceDiscovery\Exception\ServiceDiscoveryException
  • Aws\ServiceQuotas\Exception\ServiceQuotasException
  • Aws\Ses\Exception\SesException
  • Aws\SesV2\Exception\SesV2Exception
  • Aws\Sfn\Exception\SfnException
  • Aws\Shield\Exception\ShieldException
  • Aws\signer\Exception\signerException
  • Aws\SimSpaceWeaver\Exception\SimSpaceWeaverException
  • Aws\Sms\Exception\SmsException
  • Aws\SnowBall\Exception\SnowBallException
  • Aws\SnowDeviceManagement\Exception\SnowDeviceManagementException
  • Aws\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\SSMContacts\Exception\SSMContactsException
  • Aws\SSMIncidents\Exception\SSMIncidentsException
  • Aws\SsmSap\Exception\SsmSapException
  • Aws\SSO\Exception\SSOException
  • Aws\SSOAdmin\Exception\SSOAdminException
  • Aws\SSOOIDC\Exception\SSOOIDCException
  • Aws\StorageGateway\Exception\StorageGatewayException
  • Aws\Sts\Exception\StsException
  • Aws\Sts\RegionalEndpoints\Exception\ConfigurationException
  • Aws\Support\Exception\SupportException
  • Aws\SupportApp\Exception\SupportAppException
  • Aws\Swf\Exception\SwfException
  • Aws\Synthetics\Exception\SyntheticsException
  • Aws\Textract\Exception\TextractException
  • Aws\TimestreamQuery\Exception\TimestreamQueryException
  • Aws\TimestreamWrite\Exception\TimestreamWriteException
  • Aws\Tnb\Exception\TnbException
  • Aws\TranscribeService\Exception\TranscribeServiceException
  • Aws\Transfer\Exception\TransferException
  • Aws\Translate\Exception\TranslateException
  • Aws\VoiceID\Exception\VoiceIDException
  • Aws\Waf\Exception\WafException
  • Aws\WafRegional\Exception\WafRegionalException
  • Aws\WAFV2\Exception\WAFV2Exception
  • Aws\WellArchitected\Exception\WellArchitectedException
  • Aws\WorkDocs\Exception\WorkDocsException
  • Aws\WorkLink\Exception\WorkLinkException
  • Aws\WorkMail\Exception\WorkMailException
  • Aws\WorkMailMessageFlow\Exception\WorkMailMessageFlowException
  • Aws\WorkSpaces\Exception\WorkSpacesException
  • Aws\WorkSpacesWeb\Exception\WorkSpacesWebException
  • Aws\XRay\Exception\XRayException

Functions

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

AWS Amplify UI Builder 2021-08-11

Client: Aws\AmplifyUIBuilder\AmplifyUIBuilderClient
Service ID: amplifyuibuilder
Version: 2021-08-11

This page describes the parameters and results for the operations of the AWS Amplify UI Builder (2021-08-11), and shows how to use the Aws\AmplifyUIBuilder\AmplifyUIBuilderClient object to call the described operations. This documentation is specific to the 2021-08-11 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 */).

  • CreateComponent ( array $params = [] )

    Creates a new component for an Amplify app.

  • CreateForm ( array $params = [] )

    Creates a new form for an Amplify app.

  • CreateTheme ( array $params = [] )

    Creates a theme to apply to the components in an Amplify app.

  • DeleteComponent ( array $params = [] )

    Deletes a component from an Amplify app.

  • DeleteForm ( array $params = [] )

    Deletes a form from an Amplify app.

  • DeleteTheme ( array $params = [] )

    Deletes a theme from an Amplify app.

  • ExchangeCodeForToken ( array $params = [] )

    Exchanges an access code for a token.

  • ExportComponents ( array $params = [] )

    Exports component configurations to code that is ready to integrate into an Amplify app.

  • ExportForms ( array $params = [] )

    Exports form configurations to code that is ready to integrate into an Amplify app.

  • ExportThemes ( array $params = [] )

    Exports theme configurations to code that is ready to integrate into an Amplify app.

  • GetComponent ( array $params = [] )

    Returns an existing component for an Amplify app.

  • GetForm ( array $params = [] )

    Returns an existing form for an Amplify app.

  • GetMetadata ( array $params = [] )

    Returns existing metadata for an Amplify app.

  • GetTheme ( array $params = [] )

    Returns an existing theme for an Amplify app.

  • ListComponents ( array $params = [] )

    Retrieves a list of components for a specified Amplify app and backend environment.

  • ListForms ( array $params = [] )

    Retrieves a list of forms for a specified Amplify app and backend environment.

  • ListThemes ( array $params = [] )

    Retrieves a list of themes for a specified Amplify app and backend environment.

  • PutMetadataFlag ( array $params = [] )

    Stores the metadata information about a feature on a form or view.

  • RefreshToken ( array $params = [] )

    Refreshes a previously issued access token that might have expired.

  • UpdateComponent ( array $params = [] )

    Updates an existing component.

  • UpdateForm ( array $params = [] )

    Updates an existing form.

  • UpdateTheme ( array $params = [] )

    Updates an existing theme.

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:

  • ExportComponents
  • ExportForms
  • ExportThemes
  • ListComponents
  • ListForms
  • ListThemes

Operations

CreateComponent

$result = $client->createComponent([/* ... */]);
$promise = $client->createComponentAsync([/* ... */]);

Creates a new component for an Amplify app.

Parameter Syntax

$result = $client->createComponent([
    'appId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'componentToCreate' => [ // REQUIRED
        'bindingProperties' => [ // REQUIRED
            '<String>' => [
                'bindingProperties' => [
                    'bucket' => '<string>',
                    'defaultValue' => '<string>',
                    'field' => '<string>',
                    'key' => '<string>',
                    'model' => '<string>',
                    'predicates' => [
                        [
                            'and' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operator' => '<string>',
                            'or' => [...], // RECURSIVE
                        ],
                        // ...
                    ],
                    'slotName' => '<string>',
                    'userAttribute' => '<string>',
                ],
                'defaultValue' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'children' => [
            [
                'children' => [...], // RECURSIVE
                'componentType' => '<string>', // REQUIRED
                'events' => [
                    '<String>' => [
                        'action' => '<string>',
                        'bindingEvent' => '<string>',
                        'parameters' => [
                            'anchor' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>', // REQUIRED
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'fields' => [
                                '<String>' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>', // REQUIRED
                                            'property' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'global' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>', // REQUIRED
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'id' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>', // REQUIRED
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'model' => '<string>',
                            'state' => [
                                'componentName' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                                'set' => [ // REQUIRED
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>', // REQUIRED
                                            'property' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                            ],
                            'target' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>', // REQUIRED
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'type' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>', // REQUIRED
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'url' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>', // REQUIRED
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
                'name' => '<string>', // REQUIRED
                'properties' => [ // REQUIRED
                    '<String>' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'sourceId' => '<string>',
            ],
            // ...
        ],
        'collectionProperties' => [
            '<String>' => [
                'identifiers' => ['<string>', ...],
                'model' => '<string>', // REQUIRED
                'predicate' => [
                    'and' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'field' => '<string>',
                    'operand' => '<string>',
                    'operator' => '<string>',
                    'or' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'sort' => [
                    [
                        'direction' => 'ASC|DESC', // REQUIRED
                        'field' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'componentType' => '<string>', // REQUIRED
        'events' => [
            '<String>' => [
                'action' => '<string>',
                'bindingEvent' => '<string>',
                'parameters' => [
                    'anchor' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'fields' => [
                        '<String>' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>', // REQUIRED
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>', // REQUIRED
                                    'property' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>', // REQUIRED
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'global' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'id' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'model' => '<string>',
                    'state' => [
                        'componentName' => '<string>', // REQUIRED
                        'property' => '<string>', // REQUIRED
                        'set' => [ // REQUIRED
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>', // REQUIRED
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>', // REQUIRED
                                    'property' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>', // REQUIRED
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                    ],
                    'target' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'type' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'url' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'name' => '<string>', // REQUIRED
        'overrides' => [ // REQUIRED
            '<String>' => ['<string>', ...],
            // ...
        ],
        'properties' => [ // REQUIRED
            '<String>' => [
                'bindingProperties' => [
                    'field' => '<string>',
                    'property' => '<string>', // REQUIRED
                ],
                'bindings' => [
                    '<String>' => [
                        'element' => '<string>', // REQUIRED
                        'property' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'collectionBindingProperties' => [
                    'field' => '<string>',
                    'property' => '<string>', // REQUIRED
                ],
                'componentName' => '<string>',
                'concat' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'condition' => [
                    'else' => [...], // RECURSIVE
                    'field' => '<string>',
                    'operand' => '<string>',
                    'operandType' => '<string>',
                    'operator' => '<string>',
                    'property' => '<string>',
                    'then' => [...], // RECURSIVE
                ],
                'configured' => true || false,
                'defaultValue' => '<string>',
                'event' => '<string>',
                'importedValue' => '<string>',
                'model' => '<string>',
                'property' => '<string>',
                'type' => '<string>',
                'userAttribute' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'schemaVersion' => '<string>',
        'sourceId' => '<string>',
        'tags' => ['<string>', ...],
        'variants' => [ // REQUIRED
            [
                'overrides' => [
                    '<String>' => ['<string>', ...],
                    // ...
                ],
                'variantValues' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'environmentName' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app to associate with the component.

clientToken
  • Type: string

The unique client token.

componentToCreate
  • Required: Yes
  • Type: CreateComponentData structure

Represents the configuration of the component to create.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

Result Syntax

[
    'entity' => [
        'appId' => '<string>',
        'bindingProperties' => [
            '<String>' => [
                'bindingProperties' => [
                    'bucket' => '<string>',
                    'defaultValue' => '<string>',
                    'field' => '<string>',
                    'key' => '<string>',
                    'model' => '<string>',
                    'predicates' => [
                        [
                            'and' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operator' => '<string>',
                            'or' => [...], // RECURSIVE
                        ],
                        // ...
                    ],
                    'slotName' => '<string>',
                    'userAttribute' => '<string>',
                ],
                'defaultValue' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'children' => [
            [
                'children' => [...], // RECURSIVE
                'componentType' => '<string>',
                'events' => [
                    '<String>' => [
                        'action' => '<string>',
                        'bindingEvent' => '<string>',
                        'parameters' => [
                            'anchor' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'fields' => [
                                '<String>' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'global' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'id' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'model' => '<string>',
                            'state' => [
                                'componentName' => '<string>',
                                'property' => '<string>',
                                'set' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                            ],
                            'target' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'type' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'url' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
                'name' => '<string>',
                'properties' => [
                    '<String>' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'sourceId' => '<string>',
            ],
            // ...
        ],
        'collectionProperties' => [
            '<String>' => [
                'identifiers' => ['<string>', ...],
                'model' => '<string>',
                'predicate' => [
                    'and' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'field' => '<string>',
                    'operand' => '<string>',
                    'operator' => '<string>',
                    'or' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'sort' => [
                    [
                        'direction' => 'ASC|DESC',
                        'field' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'componentType' => '<string>',
        'createdAt' => <DateTime>,
        'environmentName' => '<string>',
        'events' => [
            '<String>' => [
                'action' => '<string>',
                'bindingEvent' => '<string>',
                'parameters' => [
                    'anchor' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'fields' => [
                        '<String>' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>',
                                    'property' => '<string>',
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'global' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'id' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'model' => '<string>',
                    'state' => [
                        'componentName' => '<string>',
                        'property' => '<string>',
                        'set' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>',
                                    'property' => '<string>',
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                    ],
                    'target' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'type' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'url' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'id' => '<string>',
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'overrides' => [
            '<String>' => ['<string>', ...],
            // ...
        ],
        'properties' => [
            '<String>' => [
                'bindingProperties' => [
                    'field' => '<string>',
                    'property' => '<string>',
                ],
                'bindings' => [
                    '<String>' => [
                        'element' => '<string>',
                        'property' => '<string>',
                    ],
                    // ...
                ],
                'collectionBindingProperties' => [
                    'field' => '<string>',
                    'property' => '<string>',
                ],
                'componentName' => '<string>',
                'concat' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'condition' => [
                    'else' => [...], // RECURSIVE
                    'field' => '<string>',
                    'operand' => '<string>',
                    'operandType' => '<string>',
                    'operator' => '<string>',
                    'property' => '<string>',
                    'then' => [...], // RECURSIVE
                ],
                'configured' => true || false,
                'defaultValue' => '<string>',
                'event' => '<string>',
                'importedValue' => '<string>',
                'model' => '<string>',
                'property' => '<string>',
                'type' => '<string>',
                'userAttribute' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'schemaVersion' => '<string>',
        'sourceId' => '<string>',
        'tags' => ['<string>', ...],
        'variants' => [
            [
                'overrides' => [
                    '<String>' => ['<string>', ...],
                    // ...
                ],
                'variantValues' => ['<string>', ...],
            ],
            // ...
        ],
    ],
]

Result Details

Members
entity
  • Type: Component structure

Describes the configuration of the new component.

Errors

  • ServiceQuotaExceededException:

    You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

  • ResourceConflictException:

    The resource specified in the request conflicts with an existing resource.

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

CreateForm

$result = $client->createForm([/* ... */]);
$promise = $client->createFormAsync([/* ... */]);

Creates a new form for an Amplify app.

Parameter Syntax

$result = $client->createForm([
    'appId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'environmentName' => '<string>', // REQUIRED
    'formToCreate' => [ // REQUIRED
        'cta' => [
            'cancel' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
            'clear' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
            'position' => 'top|bottom|top_and_bottom',
            'submit' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
        ],
        'dataType' => [ // REQUIRED
            'dataSourceType' => 'DataStore|Custom', // REQUIRED
            'dataTypeName' => '<string>', // REQUIRED
        ],
        'fields' => [ // REQUIRED
            '<String>' => [
                'excluded' => true || false,
                'inputType' => [
                    'defaultChecked' => true || false,
                    'defaultCountryCode' => '<string>',
                    'defaultValue' => '<string>',
                    'descriptiveText' => '<string>',
                    'isArray' => true || false,
                    'maxValue' => <float>,
                    'minValue' => <float>,
                    'name' => '<string>',
                    'placeholder' => '<string>',
                    'readOnly' => true || false,
                    'required' => true || false,
                    'step' => <float>,
                    'type' => '<string>', // REQUIRED
                    'value' => '<string>',
                    'valueMappings' => [
                        'values' => [ // REQUIRED
                            [
                                'displayValue' => [
                                    'value' => '<string>',
                                ],
                                'value' => [ // REQUIRED
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                ],
                'label' => '<string>',
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
                'validations' => [
                    [
                        'numValues' => [<integer>, ...],
                        'strValues' => ['<string>', ...],
                        'type' => '<string>', // REQUIRED
                        'validationMessage' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'formActionType' => 'create|update', // REQUIRED
        'name' => '<string>', // REQUIRED
        'schemaVersion' => '<string>', // REQUIRED
        'sectionalElements' => [ // REQUIRED
            '<String>' => [
                'level' => <integer>,
                'orientation' => '<string>',
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
                'text' => '<string>',
                'type' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'style' => [ // REQUIRED
            'horizontalGap' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
            'outerPadding' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
            'verticalGap' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
        ],
        'tags' => ['<string>', ...],
    ],
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app to associate with the form.

clientToken
  • Type: string

The unique client token.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

formToCreate
  • Required: Yes
  • Type: CreateFormData structure

Represents the configuration of the form to create.

Result Syntax

[
    'entity' => [
        'appId' => '<string>',
        'cta' => [
            'cancel' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
            'clear' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
            'position' => 'top|bottom|top_and_bottom',
            'submit' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
        ],
        'dataType' => [
            'dataSourceType' => 'DataStore|Custom',
            'dataTypeName' => '<string>',
        ],
        'environmentName' => '<string>',
        'fields' => [
            '<String>' => [
                'excluded' => true || false,
                'inputType' => [
                    'defaultChecked' => true || false,
                    'defaultCountryCode' => '<string>',
                    'defaultValue' => '<string>',
                    'descriptiveText' => '<string>',
                    'isArray' => true || false,
                    'maxValue' => <float>,
                    'minValue' => <float>,
                    'name' => '<string>',
                    'placeholder' => '<string>',
                    'readOnly' => true || false,
                    'required' => true || false,
                    'step' => <float>,
                    'type' => '<string>',
                    'value' => '<string>',
                    'valueMappings' => [
                        'values' => [
                            [
                                'displayValue' => [
                                    'value' => '<string>',
                                ],
                                'value' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                ],
                'label' => '<string>',
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
                'validations' => [
                    [
                        'numValues' => [<integer>, ...],
                        'strValues' => ['<string>', ...],
                        'type' => '<string>',
                        'validationMessage' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'formActionType' => 'create|update',
        'id' => '<string>',
        'name' => '<string>',
        'schemaVersion' => '<string>',
        'sectionalElements' => [
            '<String>' => [
                'level' => <integer>,
                'orientation' => '<string>',
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
                'text' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'style' => [
            'horizontalGap' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
            'outerPadding' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
            'verticalGap' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
entity
  • Type: Form structure

Describes the configuration of the new form.

Errors

  • ServiceQuotaExceededException:

    You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

  • ResourceConflictException:

    The resource specified in the request conflicts with an existing resource.

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

CreateTheme

$result = $client->createTheme([/* ... */]);
$promise = $client->createThemeAsync([/* ... */]);

Creates a theme to apply to the components in an Amplify app.

Parameter Syntax

$result = $client->createTheme([
    'appId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'environmentName' => '<string>', // REQUIRED
    'themeToCreate' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'overrides' => [
            [
                'key' => '<string>',
                'value' => [
                    'children' => [...], // RECURSIVE
                    'value' => '<string>',
                ],
            ],
            // ...
        ],
        'tags' => ['<string>', ...],
        'values' => [ // REQUIRED
            [
                'key' => '<string>',
                'value' => [
                    'children' => [...], // RECURSIVE
                    'value' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app associated with the theme.

clientToken
  • Type: string

The unique client token.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

themeToCreate
  • Required: Yes
  • Type: CreateThemeData structure

Represents the configuration of the theme to create.

Result Syntax

[
    'entity' => [
        'appId' => '<string>',
        'createdAt' => <DateTime>,
        'environmentName' => '<string>',
        'id' => '<string>',
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'overrides' => [
            [
                'key' => '<string>',
                'value' => [
                    'children' => [...], // RECURSIVE
                    'value' => '<string>',
                ],
            ],
            // ...
        ],
        'tags' => ['<string>', ...],
        'values' => [
            [
                'key' => '<string>',
                'value' => [
                    'children' => [...], // RECURSIVE
                    'value' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
entity
  • Type: Theme structure

Describes the configuration of the new theme.

Errors

  • ServiceQuotaExceededException:

    You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

  • ResourceConflictException:

    The resource specified in the request conflicts with an existing resource.

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

DeleteComponent

$result = $client->deleteComponent([/* ... */]);
$promise = $client->deleteComponentAsync([/* ... */]);

Deletes a component from an Amplify app.

Parameter Syntax

$result = $client->deleteComponent([
    'appId' => '<string>', // REQUIRED
    'environmentName' => '<string>', // REQUIRED
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app associated with the component to delete.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

id
  • Required: Yes
  • Type: string

The unique ID of the component to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

DeleteForm

$result = $client->deleteForm([/* ... */]);
$promise = $client->deleteFormAsync([/* ... */]);

Deletes a form from an Amplify app.

Parameter Syntax

$result = $client->deleteForm([
    'appId' => '<string>', // REQUIRED
    'environmentName' => '<string>', // REQUIRED
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app associated with the form to delete.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

id
  • Required: Yes
  • Type: string

The unique ID of the form to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

DeleteTheme

$result = $client->deleteTheme([/* ... */]);
$promise = $client->deleteThemeAsync([/* ... */]);

Deletes a theme from an Amplify app.

Parameter Syntax

$result = $client->deleteTheme([
    'appId' => '<string>', // REQUIRED
    'environmentName' => '<string>', // REQUIRED
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app associated with the theme to delete.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

id
  • Required: Yes
  • Type: string

The unique ID of the theme to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

ExchangeCodeForToken

$result = $client->exchangeCodeForToken([/* ... */]);
$promise = $client->exchangeCodeForTokenAsync([/* ... */]);

Exchanges an access code for a token.

Parameter Syntax

$result = $client->exchangeCodeForToken([
    'provider' => 'figma', // REQUIRED
    'request' => [ // REQUIRED
        'code' => '<string>', // REQUIRED
        'redirectUri' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
provider
  • Required: Yes
  • Type: string

The third-party provider for the token. The only valid value is figma.

request
  • Required: Yes
  • Type: ExchangeCodeForTokenRequestBody structure

Describes the configuration of the request.

Result Syntax

[
    'accessToken' => '<string>',
    'expiresIn' => <integer>,
    'refreshToken' => '<string>',
]

Result Details

Members
accessToken
  • Required: Yes
  • Type: string

The access token.

expiresIn
  • Required: Yes
  • Type: int

The date and time when the new access token expires.

refreshToken
  • Required: Yes
  • Type: string

The token to use to refresh a previously issued access token that might have expired.

Errors

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

ExportComponents

$result = $client->exportComponents([/* ... */]);
$promise = $client->exportComponentsAsync([/* ... */]);

Exports component configurations to code that is ready to integrate into an Amplify app.

Parameter Syntax

$result = $client->exportComponents([
    'appId' => '<string>', // REQUIRED
    'environmentName' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app to export components to.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

nextToken
  • Type: string

The token to request the next page of results.

Result Syntax

[
    'entities' => [
        [
            'appId' => '<string>',
            'bindingProperties' => [
                '<String>' => [
                    'bindingProperties' => [
                        'bucket' => '<string>',
                        'defaultValue' => '<string>',
                        'field' => '<string>',
                        'key' => '<string>',
                        'model' => '<string>',
                        'predicates' => [
                            [
                                'and' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operator' => '<string>',
                                'or' => [...], // RECURSIVE
                            ],
                            // ...
                        ],
                        'slotName' => '<string>',
                        'userAttribute' => '<string>',
                    ],
                    'defaultValue' => '<string>',
                    'type' => '<string>',
                ],
                // ...
            ],
            'children' => [
                [
                    'children' => [...], // RECURSIVE
                    'componentType' => '<string>',
                    'events' => [
                        '<String>' => [
                            'action' => '<string>',
                            'bindingEvent' => '<string>',
                            'parameters' => [
                                'anchor' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                                'fields' => [
                                    '<String>' => [
                                        'bindingProperties' => [
                                            'field' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        'bindings' => [
                                            '<String>' => [
                                                'element' => '<string>',
                                                'property' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'collectionBindingProperties' => [
                                            'field' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        'componentName' => '<string>',
                                        'concat' => [
                                            [...], // RECURSIVE
                                            // ...
                                        ],
                                        'condition' => [
                                            'else' => [...], // RECURSIVE
                                            'field' => '<string>',
                                            'operand' => '<string>',
                                            'operandType' => '<string>',
                                            'operator' => '<string>',
                                            'property' => '<string>',
                                            'then' => [...], // RECURSIVE
                                        ],
                                        'configured' => true || false,
                                        'defaultValue' => '<string>',
                                        'event' => '<string>',
                                        'importedValue' => '<string>',
                                        'model' => '<string>',
                                        'property' => '<string>',
                                        'type' => '<string>',
                                        'userAttribute' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'global' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                                'id' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                                'model' => '<string>',
                                'state' => [
                                    'componentName' => '<string>',
                                    'property' => '<string>',
                                    'set' => [
                                        'bindingProperties' => [
                                            'field' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        'bindings' => [
                                            '<String>' => [
                                                'element' => '<string>',
                                                'property' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'collectionBindingProperties' => [
                                            'field' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        'componentName' => '<string>',
                                        'concat' => [
                                            [...], // RECURSIVE
                                            // ...
                                        ],
                                        'condition' => [
                                            'else' => [...], // RECURSIVE
                                            'field' => '<string>',
                                            'operand' => '<string>',
                                            'operandType' => '<string>',
                                            'operator' => '<string>',
                                            'property' => '<string>',
                                            'then' => [...], // RECURSIVE
                                        ],
                                        'configured' => true || false,
                                        'defaultValue' => '<string>',
                                        'event' => '<string>',
                                        'importedValue' => '<string>',
                                        'model' => '<string>',
                                        'property' => '<string>',
                                        'type' => '<string>',
                                        'userAttribute' => '<string>',
                                        'value' => '<string>',
                                    ],
                                ],
                                'target' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                                'type' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                                'url' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'name' => '<string>',
                    'properties' => [
                        '<String>' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>',
                                    'property' => '<string>',
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'sourceId' => '<string>',
                ],
                // ...
            ],
            'collectionProperties' => [
                '<String>' => [
                    'identifiers' => ['<string>', ...],
                    'model' => '<string>',
                    'predicate' => [
                        'and' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'field' => '<string>',
                        'operand' => '<string>',
                        'operator' => '<string>',
                        'or' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'sort' => [
                        [
                            'direction' => 'ASC|DESC',
                            'field' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'componentType' => '<string>',
            'createdAt' => <DateTime>,
            'environmentName' => '<string>',
            'events' => [
                '<String>' => [
                    'action' => '<string>',
                    'bindingEvent' => '<string>',
                    'parameters' => [
                        'anchor' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>',
                                    'property' => '<string>',
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                        'fields' => [
                            '<String>' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'global' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>',
                                    'property' => '<string>',
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                        'id' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>',
                                    'property' => '<string>',
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                        'model' => '<string>',
                        'state' => [
                            'componentName' => '<string>',
                            'property' => '<string>',
                            'set' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                        ],
                        'target' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>',
                                    'property' => '<string>',
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                        'type' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>',
                                    'property' => '<string>',
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                        'url' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>',
                                    'property' => '<string>',
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
            'id' => '<string>',
            'modifiedAt' => <DateTime>,
            'name' => '<string>',
            'overrides' => [
                '<String>' => ['<string>', ...],
                // ...
            ],
            'properties' => [
                '<String>' => [
                    'bindingProperties' => [
                        'field' => '<string>',
                        'property' => '<string>',
                    ],
                    'bindings' => [
                        '<String>' => [
                            'element' => '<string>',
                            'property' => '<string>',
                        ],
                        // ...
                    ],
                    'collectionBindingProperties' => [
                        'field' => '<string>',
                        'property' => '<string>',
                    ],
                    'componentName' => '<string>',
                    'concat' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'condition' => [
                        'else' => [...], // RECURSIVE
                        'field' => '<string>',
                        'operand' => '<string>',
                        'operandType' => '<string>',
                        'operator' => '<string>',
                        'property' => '<string>',
                        'then' => [...], // RECURSIVE
                    ],
                    'configured' => true || false,
                    'defaultValue' => '<string>',
                    'event' => '<string>',
                    'importedValue' => '<string>',
                    'model' => '<string>',
                    'property' => '<string>',
                    'type' => '<string>',
                    'userAttribute' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'schemaVersion' => '<string>',
            'sourceId' => '<string>',
            'tags' => ['<string>', ...],
            'variants' => [
                [
                    'overrides' => [
                        '<String>' => ['<string>', ...],
                        // ...
                    ],
                    'variantValues' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
entities
  • Required: Yes
  • Type: Array of Component structures

Represents the configuration of the exported components.

nextToken
  • Type: string

The pagination token that's included if more results are available.

Errors

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

ExportForms

$result = $client->exportForms([/* ... */]);
$promise = $client->exportFormsAsync([/* ... */]);

Exports form configurations to code that is ready to integrate into an Amplify app.

Parameter Syntax

$result = $client->exportForms([
    'appId' => '<string>', // REQUIRED
    'environmentName' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app to export forms to.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

nextToken
  • Type: string

The token to request the next page of results.

Result Syntax

[
    'entities' => [
        [
            'appId' => '<string>',
            'cta' => [
                'cancel' => [
                    'children' => '<string>',
                    'excluded' => true || false,
                    'position' => [
                        'below' => '<string>',
                        'fixed' => 'first',
                        'rightOf' => '<string>',
                    ],
                ],
                'clear' => [
                    'children' => '<string>',
                    'excluded' => true || false,
                    'position' => [
                        'below' => '<string>',
                        'fixed' => 'first',
                        'rightOf' => '<string>',
                    ],
                ],
                'position' => 'top|bottom|top_and_bottom',
                'submit' => [
                    'children' => '<string>',
                    'excluded' => true || false,
                    'position' => [
                        'below' => '<string>',
                        'fixed' => 'first',
                        'rightOf' => '<string>',
                    ],
                ],
            ],
            'dataType' => [
                'dataSourceType' => 'DataStore|Custom',
                'dataTypeName' => '<string>',
            ],
            'environmentName' => '<string>',
            'fields' => [
                '<String>' => [
                    'excluded' => true || false,
                    'inputType' => [
                        'defaultChecked' => true || false,
                        'defaultCountryCode' => '<string>',
                        'defaultValue' => '<string>',
                        'descriptiveText' => '<string>',
                        'isArray' => true || false,
                        'maxValue' => <float>,
                        'minValue' => <float>,
                        'name' => '<string>',
                        'placeholder' => '<string>',
                        'readOnly' => true || false,
                        'required' => true || false,
                        'step' => <float>,
                        'type' => '<string>',
                        'value' => '<string>',
                        'valueMappings' => [
                            'values' => [
                                [
                                    'displayValue' => [
                                        'value' => '<string>',
                                    ],
                                    'value' => [
                                        'value' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'label' => '<string>',
                    'position' => [
                        'below' => '<string>',
                        'fixed' => 'first',
                        'rightOf' => '<string>',
                    ],
                    'validations' => [
                        [
                            'numValues' => [<integer>, ...],
                            'strValues' => ['<string>', ...],
                            'type' => '<string>',
                            'validationMessage' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'formActionType' => 'create|update',
            'id' => '<string>',
            'name' => '<string>',
            'schemaVersion' => '<string>',
            'sectionalElements' => [
                '<String>' => [
                    'level' => <integer>,
                    'orientation' => '<string>',
                    'position' => [
                        'below' => '<string>',
                        'fixed' => 'first',
                        'rightOf' => '<string>',
                    ],
                    'text' => '<string>',
                    'type' => '<string>',
                ],
                // ...
            ],
            'style' => [
                'horizontalGap' => [
                    'tokenReference' => '<string>',
                    'value' => '<string>',
                ],
                'outerPadding' => [
                    'tokenReference' => '<string>',
                    'value' => '<string>',
                ],
                'verticalGap' => [
                    'tokenReference' => '<string>',
                    'value' => '<string>',
                ],
            ],
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
entities
  • Required: Yes
  • Type: Array of Form structures

Represents the configuration of the exported forms.

nextToken
  • Type: string

The pagination token that's included if more results are available.

Errors

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

ExportThemes

$result = $client->exportThemes([/* ... */]);
$promise = $client->exportThemesAsync([/* ... */]);

Exports theme configurations to code that is ready to integrate into an Amplify app.

Parameter Syntax

$result = $client->exportThemes([
    'appId' => '<string>', // REQUIRED
    'environmentName' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app to export the themes to.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is part of the Amplify app.

nextToken
  • Type: string

The token to request the next page of results.

Result Syntax

[
    'entities' => [
        [
            'appId' => '<string>',
            'createdAt' => <DateTime>,
            'environmentName' => '<string>',
            'id' => '<string>',
            'modifiedAt' => <DateTime>,
            'name' => '<string>',
            'overrides' => [
                [
                    'key' => '<string>',
                    'value' => [
                        'children' => [...], // RECURSIVE
                        'value' => '<string>',
                    ],
                ],
                // ...
            ],
            'tags' => ['<string>', ...],
            'values' => [
                [
                    'key' => '<string>',
                    'value' => [
                        'children' => [...], // RECURSIVE
                        'value' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
entities
  • Required: Yes
  • Type: Array of Theme structures

Represents the configuration of the exported themes.

nextToken
  • Type: string

The pagination token that's included if more results are available.

Errors

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

GetComponent

$result = $client->getComponent([/* ... */]);
$promise = $client->getComponentAsync([/* ... */]);

Returns an existing component for an Amplify app.

Parameter Syntax

$result = $client->getComponent([
    'appId' => '<string>', // REQUIRED
    'environmentName' => '<string>', // REQUIRED
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is part of the Amplify app.

id
  • Required: Yes
  • Type: string

The unique ID of the component.

Result Syntax

[
    'component' => [
        'appId' => '<string>',
        'bindingProperties' => [
            '<String>' => [
                'bindingProperties' => [
                    'bucket' => '<string>',
                    'defaultValue' => '<string>',
                    'field' => '<string>',
                    'key' => '<string>',
                    'model' => '<string>',
                    'predicates' => [
                        [
                            'and' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operator' => '<string>',
                            'or' => [...], // RECURSIVE
                        ],
                        // ...
                    ],
                    'slotName' => '<string>',
                    'userAttribute' => '<string>',
                ],
                'defaultValue' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'children' => [
            [
                'children' => [...], // RECURSIVE
                'componentType' => '<string>',
                'events' => [
                    '<String>' => [
                        'action' => '<string>',
                        'bindingEvent' => '<string>',
                        'parameters' => [
                            'anchor' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'fields' => [
                                '<String>' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'global' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'id' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'model' => '<string>',
                            'state' => [
                                'componentName' => '<string>',
                                'property' => '<string>',
                                'set' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                            ],
                            'target' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'type' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'url' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
                'name' => '<string>',
                'properties' => [
                    '<String>' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'sourceId' => '<string>',
            ],
            // ...
        ],
        'collectionProperties' => [
            '<String>' => [
                'identifiers' => ['<string>', ...],
                'model' => '<string>',
                'predicate' => [
                    'and' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'field' => '<string>',
                    'operand' => '<string>',
                    'operator' => '<string>',
                    'or' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'sort' => [
                    [
                        'direction' => 'ASC|DESC',
                        'field' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'componentType' => '<string>',
        'createdAt' => <DateTime>,
        'environmentName' => '<string>',
        'events' => [
            '<String>' => [
                'action' => '<string>',
                'bindingEvent' => '<string>',
                'parameters' => [
                    'anchor' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'fields' => [
                        '<String>' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>',
                                    'property' => '<string>',
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'global' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'id' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'model' => '<string>',
                    'state' => [
                        'componentName' => '<string>',
                        'property' => '<string>',
                        'set' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>',
                                    'property' => '<string>',
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                    ],
                    'target' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'type' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'url' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'id' => '<string>',
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'overrides' => [
            '<String>' => ['<string>', ...],
            // ...
        ],
        'properties' => [
            '<String>' => [
                'bindingProperties' => [
                    'field' => '<string>',
                    'property' => '<string>',
                ],
                'bindings' => [
                    '<String>' => [
                        'element' => '<string>',
                        'property' => '<string>',
                    ],
                    // ...
                ],
                'collectionBindingProperties' => [
                    'field' => '<string>',
                    'property' => '<string>',
                ],
                'componentName' => '<string>',
                'concat' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'condition' => [
                    'else' => [...], // RECURSIVE
                    'field' => '<string>',
                    'operand' => '<string>',
                    'operandType' => '<string>',
                    'operator' => '<string>',
                    'property' => '<string>',
                    'then' => [...], // RECURSIVE
                ],
                'configured' => true || false,
                'defaultValue' => '<string>',
                'event' => '<string>',
                'importedValue' => '<string>',
                'model' => '<string>',
                'property' => '<string>',
                'type' => '<string>',
                'userAttribute' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'schemaVersion' => '<string>',
        'sourceId' => '<string>',
        'tags' => ['<string>', ...],
        'variants' => [
            [
                'overrides' => [
                    '<String>' => ['<string>', ...],
                    // ...
                ],
                'variantValues' => ['<string>', ...],
            ],
            // ...
        ],
    ],
]

Result Details

Members
component
  • Type: Component structure

Represents the configuration settings for the component.

Errors

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

GetForm

$result = $client->getForm([/* ... */]);
$promise = $client->getFormAsync([/* ... */]);

Returns an existing form for an Amplify app.

Parameter Syntax

$result = $client->getForm([
    'appId' => '<string>', // REQUIRED
    'environmentName' => '<string>', // REQUIRED
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is part of the Amplify app.

id
  • Required: Yes
  • Type: string

The unique ID of the form.

Result Syntax

[
    'form' => [
        'appId' => '<string>',
        'cta' => [
            'cancel' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
            'clear' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
            'position' => 'top|bottom|top_and_bottom',
            'submit' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
        ],
        'dataType' => [
            'dataSourceType' => 'DataStore|Custom',
            'dataTypeName' => '<string>',
        ],
        'environmentName' => '<string>',
        'fields' => [
            '<String>' => [
                'excluded' => true || false,
                'inputType' => [
                    'defaultChecked' => true || false,
                    'defaultCountryCode' => '<string>',
                    'defaultValue' => '<string>',
                    'descriptiveText' => '<string>',
                    'isArray' => true || false,
                    'maxValue' => <float>,
                    'minValue' => <float>,
                    'name' => '<string>',
                    'placeholder' => '<string>',
                    'readOnly' => true || false,
                    'required' => true || false,
                    'step' => <float>,
                    'type' => '<string>',
                    'value' => '<string>',
                    'valueMappings' => [
                        'values' => [
                            [
                                'displayValue' => [
                                    'value' => '<string>',
                                ],
                                'value' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                ],
                'label' => '<string>',
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
                'validations' => [
                    [
                        'numValues' => [<integer>, ...],
                        'strValues' => ['<string>', ...],
                        'type' => '<string>',
                        'validationMessage' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'formActionType' => 'create|update',
        'id' => '<string>',
        'name' => '<string>',
        'schemaVersion' => '<string>',
        'sectionalElements' => [
            '<String>' => [
                'level' => <integer>,
                'orientation' => '<string>',
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
                'text' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'style' => [
            'horizontalGap' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
            'outerPadding' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
            'verticalGap' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
form
  • Type: Form structure

Represents the configuration settings for the form.

Errors

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

GetMetadata

$result = $client->getMetadata([/* ... */]);
$promise = $client->getMetadataAsync([/* ... */]);

Returns existing metadata for an Amplify app.

Parameter Syntax

$result = $client->getMetadata([
    'appId' => '<string>', // REQUIRED
    'environmentName' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is part of the Amplify app.

Result Syntax

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

Result Details

Members
features
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to strings

Represents the configuration settings for the features metadata.

Errors

  • UnauthorizedException:

    You don't have permission to perform this operation.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

GetTheme

$result = $client->getTheme([/* ... */]);
$promise = $client->getThemeAsync([/* ... */]);

Returns an existing theme for an Amplify app.

Parameter Syntax

$result = $client->getTheme([
    'appId' => '<string>', // REQUIRED
    'environmentName' => '<string>', // REQUIRED
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is part of the Amplify app.

id
  • Required: Yes
  • Type: string

The unique ID for the theme.

Result Syntax

[
    'theme' => [
        'appId' => '<string>',
        'createdAt' => <DateTime>,
        'environmentName' => '<string>',
        'id' => '<string>',
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'overrides' => [
            [
                'key' => '<string>',
                'value' => [
                    'children' => [...], // RECURSIVE
                    'value' => '<string>',
                ],
            ],
            // ...
        ],
        'tags' => ['<string>', ...],
        'values' => [
            [
                'key' => '<string>',
                'value' => [
                    'children' => [...], // RECURSIVE
                    'value' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
theme
  • Type: Theme structure

Represents the configuration settings for the theme.

Errors

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

ListComponents

$result = $client->listComponents([/* ... */]);
$promise = $client->listComponentsAsync([/* ... */]);

Retrieves a list of components for a specified Amplify app and backend environment.

Parameter Syntax

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

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID for the Amplify app.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

maxResults
  • Type: int

The maximum number of components to retrieve.

nextToken
  • Type: string

The token to request the next page of results.

Result Syntax

[
    'entities' => [
        [
            'appId' => '<string>',
            'componentType' => '<string>',
            'environmentName' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
entities
  • Required: Yes
  • Type: Array of ComponentSummary structures

The list of components for the Amplify app.

nextToken
  • Type: string

The pagination token that's included if more results are available.

Errors

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

ListForms

$result = $client->listForms([/* ... */]);
$promise = $client->listFormsAsync([/* ... */]);

Retrieves a list of forms for a specified Amplify app and backend environment.

Parameter Syntax

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

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID for the Amplify app.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

maxResults
  • Type: int

The maximum number of forms to retrieve.

nextToken
  • Type: string

The token to request the next page of results.

Result Syntax

[
    'entities' => [
        [
            'appId' => '<string>',
            'dataType' => [
                'dataSourceType' => 'DataStore|Custom',
                'dataTypeName' => '<string>',
            ],
            'environmentName' => '<string>',
            'formActionType' => 'create|update',
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
entities
  • Required: Yes
  • Type: Array of FormSummary structures

The list of forms for the Amplify app.

nextToken
  • Type: string

The pagination token that's included if more results are available.

Errors

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

ListThemes

$result = $client->listThemes([/* ... */]);
$promise = $client->listThemesAsync([/* ... */]);

Retrieves a list of themes for a specified Amplify app and backend environment.

Parameter Syntax

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

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID for the Amplify app.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

maxResults
  • Type: int

The maximum number of theme results to return in the response.

nextToken
  • Type: string

The token to request the next page of results.

Result Syntax

[
    'entities' => [
        [
            'appId' => '<string>',
            'environmentName' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
entities
  • Required: Yes
  • Type: Array of ThemeSummary structures

The list of themes for the Amplify app.

nextToken
  • Type: string

The pagination token that's returned if more results are available.

Errors

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

PutMetadataFlag

$result = $client->putMetadataFlag([/* ... */]);
$promise = $client->putMetadataFlagAsync([/* ... */]);

Stores the metadata information about a feature on a form or view.

Parameter Syntax

$result = $client->putMetadataFlag([
    'appId' => '<string>', // REQUIRED
    'body' => [ // REQUIRED
        'newValue' => '<string>', // REQUIRED
    ],
    'environmentName' => '<string>', // REQUIRED
    'featureName' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID for the Amplify app.

body
  • Required: Yes
  • Type: PutMetadataFlagBody structure

The metadata information to store.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is part of the Amplify app.

featureName
  • Required: Yes
  • Type: string

The name of the feature associated with the metadata.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    You don't have permission to perform this operation.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

RefreshToken

$result = $client->refreshToken([/* ... */]);
$promise = $client->refreshTokenAsync([/* ... */]);

Refreshes a previously issued access token that might have expired.

Parameter Syntax

$result = $client->refreshToken([
    'provider' => 'figma', // REQUIRED
    'refreshTokenBody' => [ // REQUIRED
        'token' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
provider
  • Required: Yes
  • Type: string

The third-party provider for the token. The only valid value is figma.

refreshTokenBody
  • Required: Yes
  • Type: RefreshTokenRequestBody structure

Information about the refresh token request.

Result Syntax

[
    'accessToken' => '<string>',
    'expiresIn' => <integer>,
]

Result Details

Members
accessToken
  • Required: Yes
  • Type: string

The access token.

expiresIn
  • Required: Yes
  • Type: int

The date and time when the new access token expires.

Errors

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

UpdateComponent

$result = $client->updateComponent([/* ... */]);
$promise = $client->updateComponentAsync([/* ... */]);

Updates an existing component.

Parameter Syntax

$result = $client->updateComponent([
    'appId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'environmentName' => '<string>', // REQUIRED
    'id' => '<string>', // REQUIRED
    'updatedComponent' => [ // REQUIRED
        'bindingProperties' => [
            '<String>' => [
                'bindingProperties' => [
                    'bucket' => '<string>',
                    'defaultValue' => '<string>',
                    'field' => '<string>',
                    'key' => '<string>',
                    'model' => '<string>',
                    'predicates' => [
                        [
                            'and' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operator' => '<string>',
                            'or' => [...], // RECURSIVE
                        ],
                        // ...
                    ],
                    'slotName' => '<string>',
                    'userAttribute' => '<string>',
                ],
                'defaultValue' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'children' => [
            [
                'children' => [...], // RECURSIVE
                'componentType' => '<string>', // REQUIRED
                'events' => [
                    '<String>' => [
                        'action' => '<string>',
                        'bindingEvent' => '<string>',
                        'parameters' => [
                            'anchor' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>', // REQUIRED
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'fields' => [
                                '<String>' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>', // REQUIRED
                                            'property' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'global' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>', // REQUIRED
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'id' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>', // REQUIRED
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'model' => '<string>',
                            'state' => [
                                'componentName' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                                'set' => [ // REQUIRED
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>', // REQUIRED
                                            'property' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                            ],
                            'target' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>', // REQUIRED
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'type' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>', // REQUIRED
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'url' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>', // REQUIRED
                                        'property' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>', // REQUIRED
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
                'name' => '<string>', // REQUIRED
                'properties' => [ // REQUIRED
                    '<String>' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'sourceId' => '<string>',
            ],
            // ...
        ],
        'collectionProperties' => [
            '<String>' => [
                'identifiers' => ['<string>', ...],
                'model' => '<string>', // REQUIRED
                'predicate' => [
                    'and' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'field' => '<string>',
                    'operand' => '<string>',
                    'operator' => '<string>',
                    'or' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'sort' => [
                    [
                        'direction' => 'ASC|DESC', // REQUIRED
                        'field' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'componentType' => '<string>',
        'events' => [
            '<String>' => [
                'action' => '<string>',
                'bindingEvent' => '<string>',
                'parameters' => [
                    'anchor' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'fields' => [
                        '<String>' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>', // REQUIRED
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>', // REQUIRED
                                    'property' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>', // REQUIRED
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'global' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'id' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'model' => '<string>',
                    'state' => [
                        'componentName' => '<string>', // REQUIRED
                        'property' => '<string>', // REQUIRED
                        'set' => [ // REQUIRED
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>', // REQUIRED
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>', // REQUIRED
                                    'property' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>', // REQUIRED
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                    ],
                    'target' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'type' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'url' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>', // REQUIRED
                                'property' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>', // REQUIRED
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'id' => '<string>',
        'name' => '<string>',
        'overrides' => [
            '<String>' => ['<string>', ...],
            // ...
        ],
        'properties' => [
            '<String>' => [
                'bindingProperties' => [
                    'field' => '<string>',
                    'property' => '<string>', // REQUIRED
                ],
                'bindings' => [
                    '<String>' => [
                        'element' => '<string>', // REQUIRED
                        'property' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'collectionBindingProperties' => [
                    'field' => '<string>',
                    'property' => '<string>', // REQUIRED
                ],
                'componentName' => '<string>',
                'concat' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'condition' => [
                    'else' => [...], // RECURSIVE
                    'field' => '<string>',
                    'operand' => '<string>',
                    'operandType' => '<string>',
                    'operator' => '<string>',
                    'property' => '<string>',
                    'then' => [...], // RECURSIVE
                ],
                'configured' => true || false,
                'defaultValue' => '<string>',
                'event' => '<string>',
                'importedValue' => '<string>',
                'model' => '<string>',
                'property' => '<string>',
                'type' => '<string>',
                'userAttribute' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'schemaVersion' => '<string>',
        'sourceId' => '<string>',
        'variants' => [
            [
                'overrides' => [
                    '<String>' => ['<string>', ...],
                    // ...
                ],
                'variantValues' => ['<string>', ...],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID for the Amplify app.

clientToken
  • Type: string

The unique client token.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is part of the Amplify app.

id
  • Required: Yes
  • Type: string

The unique ID for the component.

updatedComponent
  • Required: Yes
  • Type: UpdateComponentData structure

The configuration of the updated component.

Result Syntax

[
    'entity' => [
        'appId' => '<string>',
        'bindingProperties' => [
            '<String>' => [
                'bindingProperties' => [
                    'bucket' => '<string>',
                    'defaultValue' => '<string>',
                    'field' => '<string>',
                    'key' => '<string>',
                    'model' => '<string>',
                    'predicates' => [
                        [
                            'and' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operator' => '<string>',
                            'or' => [...], // RECURSIVE
                        ],
                        // ...
                    ],
                    'slotName' => '<string>',
                    'userAttribute' => '<string>',
                ],
                'defaultValue' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'children' => [
            [
                'children' => [...], // RECURSIVE
                'componentType' => '<string>',
                'events' => [
                    '<String>' => [
                        'action' => '<string>',
                        'bindingEvent' => '<string>',
                        'parameters' => [
                            'anchor' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'fields' => [
                                '<String>' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'global' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'id' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'model' => '<string>',
                            'state' => [
                                'componentName' => '<string>',
                                'property' => '<string>',
                                'set' => [
                                    'bindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'bindings' => [
                                        '<String>' => [
                                            'element' => '<string>',
                                            'property' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'collectionBindingProperties' => [
                                        'field' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    'componentName' => '<string>',
                                    'concat' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'condition' => [
                                        'else' => [...], // RECURSIVE
                                        'field' => '<string>',
                                        'operand' => '<string>',
                                        'operandType' => '<string>',
                                        'operator' => '<string>',
                                        'property' => '<string>',
                                        'then' => [...], // RECURSIVE
                                    ],
                                    'configured' => true || false,
                                    'defaultValue' => '<string>',
                                    'event' => '<string>',
                                    'importedValue' => '<string>',
                                    'model' => '<string>',
                                    'property' => '<string>',
                                    'type' => '<string>',
                                    'userAttribute' => '<string>',
                                    'value' => '<string>',
                                ],
                            ],
                            'target' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'type' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                            'url' => [
                                'bindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'bindings' => [
                                    '<String>' => [
                                        'element' => '<string>',
                                        'property' => '<string>',
                                    ],
                                    // ...
                                ],
                                'collectionBindingProperties' => [
                                    'field' => '<string>',
                                    'property' => '<string>',
                                ],
                                'componentName' => '<string>',
                                'concat' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'condition' => [
                                    'else' => [...], // RECURSIVE
                                    'field' => '<string>',
                                    'operand' => '<string>',
                                    'operandType' => '<string>',
                                    'operator' => '<string>',
                                    'property' => '<string>',
                                    'then' => [...], // RECURSIVE
                                ],
                                'configured' => true || false,
                                'defaultValue' => '<string>',
                                'event' => '<string>',
                                'importedValue' => '<string>',
                                'model' => '<string>',
                                'property' => '<string>',
                                'type' => '<string>',
                                'userAttribute' => '<string>',
                                'value' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
                'name' => '<string>',
                'properties' => [
                    '<String>' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'sourceId' => '<string>',
            ],
            // ...
        ],
        'collectionProperties' => [
            '<String>' => [
                'identifiers' => ['<string>', ...],
                'model' => '<string>',
                'predicate' => [
                    'and' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'field' => '<string>',
                    'operand' => '<string>',
                    'operator' => '<string>',
                    'or' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'sort' => [
                    [
                        'direction' => 'ASC|DESC',
                        'field' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'componentType' => '<string>',
        'createdAt' => <DateTime>,
        'environmentName' => '<string>',
        'events' => [
            '<String>' => [
                'action' => '<string>',
                'bindingEvent' => '<string>',
                'parameters' => [
                    'anchor' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'fields' => [
                        '<String>' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>',
                                    'property' => '<string>',
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'global' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'id' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'model' => '<string>',
                    'state' => [
                        'componentName' => '<string>',
                        'property' => '<string>',
                        'set' => [
                            'bindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'bindings' => [
                                '<String>' => [
                                    'element' => '<string>',
                                    'property' => '<string>',
                                ],
                                // ...
                            ],
                            'collectionBindingProperties' => [
                                'field' => '<string>',
                                'property' => '<string>',
                            ],
                            'componentName' => '<string>',
                            'concat' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'condition' => [
                                'else' => [...], // RECURSIVE
                                'field' => '<string>',
                                'operand' => '<string>',
                                'operandType' => '<string>',
                                'operator' => '<string>',
                                'property' => '<string>',
                                'then' => [...], // RECURSIVE
                            ],
                            'configured' => true || false,
                            'defaultValue' => '<string>',
                            'event' => '<string>',
                            'importedValue' => '<string>',
                            'model' => '<string>',
                            'property' => '<string>',
                            'type' => '<string>',
                            'userAttribute' => '<string>',
                            'value' => '<string>',
                        ],
                    ],
                    'target' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'type' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                    'url' => [
                        'bindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'bindings' => [
                            '<String>' => [
                                'element' => '<string>',
                                'property' => '<string>',
                            ],
                            // ...
                        ],
                        'collectionBindingProperties' => [
                            'field' => '<string>',
                            'property' => '<string>',
                        ],
                        'componentName' => '<string>',
                        'concat' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'condition' => [
                            'else' => [...], // RECURSIVE
                            'field' => '<string>',
                            'operand' => '<string>',
                            'operandType' => '<string>',
                            'operator' => '<string>',
                            'property' => '<string>',
                            'then' => [...], // RECURSIVE
                        ],
                        'configured' => true || false,
                        'defaultValue' => '<string>',
                        'event' => '<string>',
                        'importedValue' => '<string>',
                        'model' => '<string>',
                        'property' => '<string>',
                        'type' => '<string>',
                        'userAttribute' => '<string>',
                        'value' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'id' => '<string>',
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'overrides' => [
            '<String>' => ['<string>', ...],
            // ...
        ],
        'properties' => [
            '<String>' => [
                'bindingProperties' => [
                    'field' => '<string>',
                    'property' => '<string>',
                ],
                'bindings' => [
                    '<String>' => [
                        'element' => '<string>',
                        'property' => '<string>',
                    ],
                    // ...
                ],
                'collectionBindingProperties' => [
                    'field' => '<string>',
                    'property' => '<string>',
                ],
                'componentName' => '<string>',
                'concat' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'condition' => [
                    'else' => [...], // RECURSIVE
                    'field' => '<string>',
                    'operand' => '<string>',
                    'operandType' => '<string>',
                    'operator' => '<string>',
                    'property' => '<string>',
                    'then' => [...], // RECURSIVE
                ],
                'configured' => true || false,
                'defaultValue' => '<string>',
                'event' => '<string>',
                'importedValue' => '<string>',
                'model' => '<string>',
                'property' => '<string>',
                'type' => '<string>',
                'userAttribute' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'schemaVersion' => '<string>',
        'sourceId' => '<string>',
        'tags' => ['<string>', ...],
        'variants' => [
            [
                'overrides' => [
                    '<String>' => ['<string>', ...],
                    // ...
                ],
                'variantValues' => ['<string>', ...],
            ],
            // ...
        ],
    ],
]

Result Details

Members
entity
  • Type: Component structure

Describes the configuration of the updated component.

Errors

  • ResourceConflictException:

    The resource specified in the request conflicts with an existing resource.

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

UpdateForm

$result = $client->updateForm([/* ... */]);
$promise = $client->updateFormAsync([/* ... */]);

Updates an existing form.

Parameter Syntax

$result = $client->updateForm([
    'appId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'environmentName' => '<string>', // REQUIRED
    'id' => '<string>', // REQUIRED
    'updatedForm' => [ // REQUIRED
        'cta' => [
            'cancel' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
            'clear' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
            'position' => 'top|bottom|top_and_bottom',
            'submit' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
        ],
        'dataType' => [
            'dataSourceType' => 'DataStore|Custom', // REQUIRED
            'dataTypeName' => '<string>', // REQUIRED
        ],
        'fields' => [
            '<String>' => [
                'excluded' => true || false,
                'inputType' => [
                    'defaultChecked' => true || false,
                    'defaultCountryCode' => '<string>',
                    'defaultValue' => '<string>',
                    'descriptiveText' => '<string>',
                    'isArray' => true || false,
                    'maxValue' => <float>,
                    'minValue' => <float>,
                    'name' => '<string>',
                    'placeholder' => '<string>',
                    'readOnly' => true || false,
                    'required' => true || false,
                    'step' => <float>,
                    'type' => '<string>', // REQUIRED
                    'value' => '<string>',
                    'valueMappings' => [
                        'values' => [ // REQUIRED
                            [
                                'displayValue' => [
                                    'value' => '<string>',
                                ],
                                'value' => [ // REQUIRED
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                ],
                'label' => '<string>',
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
                'validations' => [
                    [
                        'numValues' => [<integer>, ...],
                        'strValues' => ['<string>', ...],
                        'type' => '<string>', // REQUIRED
                        'validationMessage' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'formActionType' => 'create|update',
        'name' => '<string>',
        'schemaVersion' => '<string>',
        'sectionalElements' => [
            '<String>' => [
                'level' => <integer>,
                'orientation' => '<string>',
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
                'text' => '<string>',
                'type' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'style' => [
            'horizontalGap' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
            'outerPadding' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
            'verticalGap' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
        ],
    ],
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID for the Amplify app.

clientToken
  • Type: string

The unique client token.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is part of the Amplify app.

id
  • Required: Yes
  • Type: string

The unique ID for the form.

updatedForm
  • Required: Yes
  • Type: UpdateFormData structure

The request accepts the following data in JSON format.

Result Syntax

[
    'entity' => [
        'appId' => '<string>',
        'cta' => [
            'cancel' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
            'clear' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
            'position' => 'top|bottom|top_and_bottom',
            'submit' => [
                'children' => '<string>',
                'excluded' => true || false,
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
            ],
        ],
        'dataType' => [
            'dataSourceType' => 'DataStore|Custom',
            'dataTypeName' => '<string>',
        ],
        'environmentName' => '<string>',
        'fields' => [
            '<String>' => [
                'excluded' => true || false,
                'inputType' => [
                    'defaultChecked' => true || false,
                    'defaultCountryCode' => '<string>',
                    'defaultValue' => '<string>',
                    'descriptiveText' => '<string>',
                    'isArray' => true || false,
                    'maxValue' => <float>,
                    'minValue' => <float>,
                    'name' => '<string>',
                    'placeholder' => '<string>',
                    'readOnly' => true || false,
                    'required' => true || false,
                    'step' => <float>,
                    'type' => '<string>',
                    'value' => '<string>',
                    'valueMappings' => [
                        'values' => [
                            [
                                'displayValue' => [
                                    'value' => '<string>',
                                ],
                                'value' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                ],
                'label' => '<string>',
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
                'validations' => [
                    [
                        'numValues' => [<integer>, ...],
                        'strValues' => ['<string>', ...],
                        'type' => '<string>',
                        'validationMessage' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'formActionType' => 'create|update',
        'id' => '<string>',
        'name' => '<string>',
        'schemaVersion' => '<string>',
        'sectionalElements' => [
            '<String>' => [
                'level' => <integer>,
                'orientation' => '<string>',
                'position' => [
                    'below' => '<string>',
                    'fixed' => 'first',
                    'rightOf' => '<string>',
                ],
                'text' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'style' => [
            'horizontalGap' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
            'outerPadding' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
            'verticalGap' => [
                'tokenReference' => '<string>',
                'value' => '<string>',
            ],
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
entity
  • Type: Form structure

Describes the configuration of the updated form.

Errors

  • ResourceConflictException:

    The resource specified in the request conflicts with an existing resource.

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

UpdateTheme

$result = $client->updateTheme([/* ... */]);
$promise = $client->updateThemeAsync([/* ... */]);

Updates an existing theme.

Parameter Syntax

$result = $client->updateTheme([
    'appId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'environmentName' => '<string>', // REQUIRED
    'id' => '<string>', // REQUIRED
    'updatedTheme' => [ // REQUIRED
        'id' => '<string>',
        'name' => '<string>',
        'overrides' => [
            [
                'key' => '<string>',
                'value' => [
                    'children' => [...], // RECURSIVE
                    'value' => '<string>',
                ],
            ],
            // ...
        ],
        'values' => [ // REQUIRED
            [
                'key' => '<string>',
                'value' => [
                    'children' => [...], // RECURSIVE
                    'value' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The unique ID for the Amplify app.

clientToken
  • Type: string

The unique client token.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is part of the Amplify app.

id
  • Required: Yes
  • Type: string

The unique ID for the theme.

updatedTheme
  • Required: Yes
  • Type: UpdateThemeData structure

The configuration of the updated theme.

Result Syntax

[
    'entity' => [
        'appId' => '<string>',
        'createdAt' => <DateTime>,
        'environmentName' => '<string>',
        'id' => '<string>',
        'modifiedAt' => <DateTime>,
        'name' => '<string>',
        'overrides' => [
            [
                'key' => '<string>',
                'value' => [
                    'children' => [...], // RECURSIVE
                    'value' => '<string>',
                ],
            ],
            // ...
        ],
        'tags' => ['<string>', ...],
        'values' => [
            [
                'key' => '<string>',
                'value' => [
                    'children' => [...], // RECURSIVE
                    'value' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
entity
  • Type: Theme structure

Describes the configuration of the updated theme.

Errors

  • ResourceConflictException:

    The resource specified in the request conflicts with an existing resource.

  • InternalServerException:

    An internal error has occurred. Please retry your request.

  • InvalidParameterException:

    An invalid or out-of-range value was supplied for the input parameter.

Shapes

ActionParameters

Description

Represents the event action configuration for an element of a Component or ComponentChild. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. ActionParameters defines the action that is performed when an event occurs on the component.

Members
anchor
  • Type: ComponentProperty structure

The HTML anchor link to the location to open. Specify this value for a navigation action.

fields
  • Type: Associative array of custom strings keys (String) to ComponentProperty structures

A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.

global
  • Type: ComponentProperty structure

Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

id
  • Type: ComponentProperty structure

The unique ID of the component that the ActionParameters apply to.

model
  • Type: string

The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

state
  • Type: MutationActionSetStateParameter structure

A key-value pair that specifies the state property name and its initial value.

target
  • Type: ComponentProperty structure

The element within the same component to modify when the action occurs.

type
  • Type: ComponentProperty structure

The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

url
  • Type: ComponentProperty structure

The URL to the location to open. Specify this value for a navigation action.

Component

Description

Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use ComponentChild to configure an instance of a Component. A ComponentChild instance inherits the configuration of the main Component.

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app associated with the component.

bindingProperties
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to ComponentBindingPropertiesValue structures

The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

children
  • Type: Array of ComponentChild structures

A list of the component's ComponentChild instances.

collectionProperties
  • Type: Associative array of custom strings keys (String) to ComponentDataConfiguration structures

The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties.

componentType
  • Required: Yes
  • Type: string

The type of the component. This can be an Amplify custom UI component or another custom component.

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

The time that the component was created.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

events
  • Type: Associative array of custom strings keys (String) to ComponentEvent structures

Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

id
  • Required: Yes
  • Type: string

The unique ID of the component.

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

The time that the component was modified.

name
  • Required: Yes
  • Type: string

The name of the component.

overrides
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to stringss

Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides.

properties
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to ComponentProperty structures

Describes the component's properties. You can't specify tags as a valid property for properties.

schemaVersion
  • Type: string

The schema version of the component when it was imported.

sourceId
  • Type: string

The unique ID of the component in its original source system, such as Figma.

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

One or more key-value pairs to use when tagging the component.

variants
  • Required: Yes
  • Type: Array of ComponentVariant structures

A list of the component's variants. A variant is a unique style configuration of a main component.

ComponentBindingPropertiesValue

Description

Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app.

Members
bindingProperties
  • Type: ComponentBindingPropertiesValueProperties structure

Describes the properties to customize with data at runtime.

defaultValue
  • Type: string

The default value of the property.

type
  • Type: string

The property type.

ComponentBindingPropertiesValueProperties

Description

Represents the data binding configuration for a specific property using data stored in Amazon Web Services. For Amazon Web Services connected properties, you can bind a property to data stored in an Amazon S3 bucket, an Amplify DataStore model or an authenticated user attribute.

Members
bucket
  • Type: string

An Amazon S3 bucket.

defaultValue
  • Type: string

The default value to assign to the property.

field
  • Type: string

The field to bind the data to.

key
  • Type: string

The storage key for an Amazon S3 bucket.

model
  • Type: string

An Amplify DataStore model.

predicates
  • Type: Array of Predicate structures

A list of predicates for binding a component's properties to data.

slotName
  • Type: string

The name of a component slot.

userAttribute
  • Type: string

An authenticated user attribute.

ComponentChild

Description

A nested UI configuration within a parent Component.

Members
children
  • Type: Array of ComponentChild structures

The list of ComponentChild instances for this component.

componentType
  • Required: Yes
  • Type: string

The type of the child component.

events
  • Type: Associative array of custom strings keys (String) to ComponentEvent structures

Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

name
  • Required: Yes
  • Type: string

The name of the child component.

properties
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to ComponentProperty structures

Describes the properties of the child component. You can't specify tags as a valid property for properties.

sourceId
  • Type: string

The unique ID of the child component in its original source system, such as Figma.

ComponentConditionProperty

Description

Represents a conditional expression to set a component property. Use ComponentConditionProperty to set a property to different values conditionally, based on the value of another property.

Members
else
  • Type: ComponentProperty structure

The value to assign to the property if the condition is not met.

field
  • Type: string

The name of a field. Specify this when the property is a data model.

operand
  • Type: string

The value of the property to evaluate.

operandType
  • Type: string

The type of the property to evaluate.

operator
  • Type: string

The operator to use to perform the evaluation, such as eq to represent equals.

property
  • Type: string

The name of the conditional property.

then
  • Type: ComponentProperty structure

The value to assign to the property if the condition is met.

ComponentDataConfiguration

Description

Describes the configuration for binding a component's properties to data.

Members
identifiers
  • Type: Array of strings

A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.

model
  • Required: Yes
  • Type: string

The name of the data model to use to bind data to a component.

predicate
  • Type: Predicate structure

Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.

sort
  • Type: Array of SortProperty structures

Describes how to sort the component's properties.

ComponentEvent

Description

Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild. A button click is an example of an event.

Members
action
  • Type: string

The action to perform when a specific event is raised.

bindingEvent
  • Type: string

Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

parameters
  • Type: ActionParameters structure

Describes information about the action.

ComponentProperty

Description

Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.

Members
bindingProperties
  • Type: ComponentPropertyBindingProperties structure

The information to bind the component property to data at runtime.

bindings
  • Type: Associative array of custom strings keys (String) to FormBindingElement structures

The information to bind the component property to form data.

collectionBindingProperties
  • Type: ComponentPropertyBindingProperties structure

The information to bind the component property to data at runtime. Use this for collection components.

componentName
  • Type: string

The name of the component that is affected by an event.

concat
  • Type: Array of ComponentProperty structures

A list of component properties to concatenate to create the value to assign to this component property.

condition
  • Type: ComponentConditionProperty structure

The conditional expression to use to assign a value to the component property.

configured
  • Type: boolean

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue
  • Type: string

The default value to assign to the component property.

event
  • Type: string

An event that occurs in your app. Use this for workflow data binding.

importedValue
  • Type: string

The default value assigned to the property when the component is imported into an app.

model
  • Type: string

The data model to use to assign a value to the component property.

property
  • Type: string

The name of the component's property that is affected by an event.

type
  • Type: string

The component type.

userAttribute
  • Type: string

An authenticated user attribute to use to assign a value to the component property.

value
  • Type: string

The value to assign to the component property.

ComponentPropertyBindingProperties

Description

Associates a component property to a binding property. This enables exposed properties on the top level component to propagate data to the component's property values.

Members
field
  • Type: string

The data field to bind the property to.

property
  • Required: Yes
  • Type: string

The component property to bind to the data field.

ComponentSummary

Description

Contains a summary of a component. This is a read-only data type that is returned by ListComponents.

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app associated with the component.

componentType
  • Required: Yes
  • Type: string

The component type.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

id
  • Required: Yes
  • Type: string

The unique ID of the component.

name
  • Required: Yes
  • Type: string

The name of the component.

ComponentVariant

Description

Describes the style configuration of a unique variation of a main component.

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

The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides.

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

The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.

CreateComponentData

Description

Represents all of the information that is required to create a component.

Members
bindingProperties
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to ComponentBindingPropertiesValue structures

The data binding information for the component's properties.

children
  • Type: Array of ComponentChild structures

A list of child components that are instances of the main component.

collectionProperties
  • Type: Associative array of custom strings keys (String) to ComponentDataConfiguration structures

The data binding configuration for customizing a component's properties. Use this for a collection component.

componentType
  • Required: Yes
  • Type: string

The component type. This can be an Amplify custom UI component or another custom component.

events
  • Type: Associative array of custom strings keys (String) to ComponentEvent structures

The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

name
  • Required: Yes
  • Type: string

The name of the component

overrides
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to stringss

Describes the component properties that can be overriden to customize an instance of the component.

properties
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to ComponentProperty structures

Describes the component's properties.

schemaVersion
  • Type: string

The schema version of the component when it was imported.

sourceId
  • Type: string

The unique ID of the component in its original source system, such as Figma.

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

One or more key-value pairs to use when tagging the component data.

variants
  • Required: Yes
  • Type: Array of ComponentVariant structures

A list of the unique variants of this component.

CreateFormData

Description

Represents all of the information that is required to create a form.

Members
cta
  • Type: FormCTA structure

The FormCTA object that stores the call to action configuration for the form.

dataType
  • Required: Yes
  • Type: FormDataTypeConfig structure

The type of data source to use to create the form.

fields
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to FieldConfig structures

The configuration information for the form's fields.

formActionType
  • Required: Yes
  • Type: string

Specifies whether to perform a create or update action on the form.

name
  • Required: Yes
  • Type: string

The name of the form.

schemaVersion
  • Required: Yes
  • Type: string

The schema version of the form.

sectionalElements
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to SectionalElement structures

The configuration information for the visual helper elements for the form. These elements are not associated with any data.

style
  • Required: Yes
  • Type: FormStyle structure

The configuration for the form's style.

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

One or more key-value pairs to use when tagging the form data.

CreateThemeData

Description

Represents all of the information that is required to create a theme.

Members
name
  • Required: Yes
  • Type: string

The name of the theme.

overrides
  • Type: Array of ThemeValues structures

Describes the properties that can be overriden to customize an instance of the theme.

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

One or more key-value pairs to use when tagging the theme data.

values
  • Required: Yes
  • Type: Array of ThemeValues structures

A list of key-value pairs that defines the properties of the theme.

ExchangeCodeForTokenRequestBody

Description

Describes the configuration of a request to exchange an access code for a token.

Members
code
  • Required: Yes
  • Type: string

The access code to send in the request.

redirectUri
  • Required: Yes
  • Type: string

The location of the application that will receive the access code.

FieldConfig

Description

Describes the configuration information for a field in a table.

Members
excluded
  • Type: boolean

Specifies whether to hide a field.

inputType
  • Type: FieldInputConfig structure

Describes the configuration for the default input value to display for a field.

label
  • Type: string

The label for the field.

position
  • Type: FieldPosition structure

Specifies the field position.

validations
  • Type: Array of FieldValidationConfiguration structures

The validations to perform on the value in the field.

FieldInputConfig

Description

Describes the configuration for the default input values to display for a field.

Members
defaultChecked
  • Type: boolean

Specifies whether a field has a default value.

defaultCountryCode
  • Type: string

The default country code for a phone number.

defaultValue
  • Type: string

The default value for the field.

descriptiveText
  • Type: string

The text to display to describe the field.

isArray
  • Type: boolean

Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.

maxValue
  • Type: float

The maximum value to display for the field.

minValue
  • Type: float

The minimum value to display for the field.

name
  • Type: string

The name of the field.

placeholder
  • Type: string

The text to display as a placeholder for the field.

readOnly
  • Type: boolean

Specifies a read only field.

required
  • Type: boolean

Specifies a field that requires input.

step
  • Type: float

The stepping increment for a numeric value in a field.

type
  • Required: Yes
  • Type: string

The input type for the field.

value
  • Type: string

The value for the field.

valueMappings
  • Type: ValueMappings structure

The information to use to customize the input fields with data at runtime.

FieldPosition

Description

Describes the field position.

Members
below
  • Type: string

The field position is below the field specified by the string.

fixed
  • Type: string

The field position is fixed and doesn't change in relation to other fields.

rightOf
  • Type: string

The field position is to the right of the field specified by the string.

FieldValidationConfiguration

Description

Describes the validation configuration for a field.

Members
numValues
  • Type: Array of ints

The validation to perform on a number value.

strValues
  • Type: Array of strings

The validation to perform on a string value.

type
  • Required: Yes
  • Type: string

The validation to perform on an object type.

validationMessage
  • Type: string

The validation message to display.

Form

Description

Contains the configuration settings for a Form user interface (UI) element for an Amplify app. A form is a component you can add to your project by specifying a data source as the default configuration for the form.

Members
appId
  • Required: Yes
  • Type: string

The unique ID of the Amplify app associated with the form.

cta
  • Type: FormCTA structure

Stores the call to action configuration for the form.

dataType
  • Required: Yes
  • Type: FormDataTypeConfig structure

The type of data source to use to create the form.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

fields
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to FieldConfig structures

Stores the information about the form's fields.

formActionType
  • Required: Yes
  • Type: string

The operation to perform on the specified form.

id
  • Required: Yes
  • Type: string

The unique ID of the form.

name
  • Required: Yes
  • Type: string

The name of the form.

schemaVersion
  • Required: Yes
  • Type: string

The schema version of the form when it was imported.

sectionalElements
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to SectionalElement structures

Stores the visual helper elements for the form that are not associated with any data.

style
  • Required: Yes
  • Type: FormStyle structure

Stores the configuration for the form's style.

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

One or more key-value pairs to use when tagging the form.

FormBindingElement

Description

Describes how to bind a component property to form data.

Members
element
  • Required: Yes
  • Type: string

The name of the component to retrieve a value from.

property
  • Required: Yes
  • Type: string

The property to retrieve a value from.

FormButton

Description

Describes the configuration for a button UI element that is a part of a form.

Members
children
  • Type: string

Describes the button's properties.

excluded
  • Type: boolean

Specifies whether the button is visible on the form.

position
  • Type: FieldPosition structure

The position of the button.

FormCTA

Description

Describes the call to action button configuration for the form.

Members
cancel
  • Type: FormButton structure

Displays a cancel button.

clear
  • Type: FormButton structure

Displays a clear button.

position
  • Type: string

The position of the button.

submit
  • Type: FormButton structure

Displays a submit button.

FormDataTypeConfig

Description

Describes the data type configuration for the data source associated with a form.

Members
dataSourceType
  • Required: Yes
  • Type: string

The data source type, either an Amplify DataStore model or a custom data type.

dataTypeName
  • Required: Yes
  • Type: string

The unique name of the data type you are using as the data source for the form.

FormInputValueProperty

Description

Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.

Members
value
  • Type: string

The value to assign to the input field.

FormStyle

Description

Describes the configuration for the form's style.

Members
horizontalGap
  • Type: FormStyleConfig structure

The spacing for the horizontal gap.

outerPadding
  • Type: FormStyleConfig structure

The size of the outer padding for the form.

verticalGap
  • Type: FormStyleConfig structure

The spacing for the vertical gap.

FormStyleConfig

Description

Describes the configuration settings for the form's style properties.

Members
tokenReference
  • Type: string

A reference to a design token to use to bind the form's style properties to an existing theme.

value
  • Type: string

The value of the style setting.

FormSummary

Description

Describes the basic information about a form.

Members
appId
  • Required: Yes
  • Type: string

The unique ID for the app associated with the form summary.

dataType
  • Required: Yes
  • Type: FormDataTypeConfig structure

The form's data source type.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is part of the Amplify app.

formActionType
  • Required: Yes
  • Type: string

The type of operation to perform on the form.

id
  • Required: Yes
  • Type: string

The ID of the form.

name
  • Required: Yes
  • Type: string

The name of the form.

InternalServerException

Description

An internal error has occurred. Please retry your request.

Members
message
  • Type: string

InvalidParameterException

Description

An invalid or out-of-range value was supplied for the input parameter.

Members
message
  • Type: string

MutationActionSetStateParameter

Description

Represents the state configuration when an action modifies a property of another element within the same component.

Members
componentName
  • Required: Yes
  • Type: string

The name of the component that is being modified.

property
  • Required: Yes
  • Type: string

The name of the component property to apply the state configuration to.

set
  • Required: Yes
  • Type: ComponentProperty structure

The state configuration to assign to the property.

Predicate

Description

Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.

Members
and
  • Type: Array of Predicate structures

A list of predicates to combine logically.

field
  • Type: string

The field to query.

operand
  • Type: string

The value to use when performing the evaluation.

operator
  • Type: string

The operator to use to perform the evaluation.

or
  • Type: Array of Predicate structures

A list of predicates to combine logically.

PutMetadataFlagBody

Description

Stores the metadata information about a feature on a form or view.

Members
newValue
  • Required: Yes
  • Type: string

The new information to store.

RefreshTokenRequestBody

Description

Describes a refresh token.

Members
token
  • Required: Yes
  • Type: string

The token to use to refresh a previously issued access token that might have expired.

ResourceConflictException

Description

The resource specified in the request conflicts with an existing resource.

Members
message
  • Type: string

ResourceNotFoundException

Description

The requested resource does not exist, or access was denied.

Members
message
  • Type: string

SectionalElement

Description

Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data.

Members
level
  • Type: int

Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.

orientation
  • Type: string

Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.

position
  • Type: FieldPosition structure

Specifies the position of the text in a field for a Text sectional element.

text
  • Type: string

The text for a Text sectional element.

type
  • Required: Yes
  • Type: string

The type of sectional element. Valid values are Heading, Text, and Divider.

ServiceQuotaExceededException

Description

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

Members
message
  • Type: string

SortProperty

Description

Describes how to sort the data that you bind to a component.

Members
direction
  • Required: Yes
  • Type: string

The direction of the sort, either ascending or descending.

field
  • Required: Yes
  • Type: string

The field to perform the sort on.

Theme

Description

A theme is a collection of style settings that apply globally to the components associated with an Amplify application.

Members
appId
  • Required: Yes
  • Type: string

The unique ID for the Amplify app associated with the theme.

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

The time that the theme was created.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is a part of the Amplify app.

id
  • Required: Yes
  • Type: string

The ID for the theme.

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

The time that the theme was modified.

name
  • Required: Yes
  • Type: string

The name of the theme.

overrides
  • Type: Array of ThemeValues structures

Describes the properties that can be overriden to customize a theme.

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

One or more key-value pairs to use when tagging the theme.

values
  • Required: Yes
  • Type: Array of ThemeValues structures

A list of key-value pairs that defines the properties of the theme.

ThemeSummary

Description

Describes the basic information about a theme.

Members
appId
  • Required: Yes
  • Type: string

The unique ID for the app associated with the theme summary.

environmentName
  • Required: Yes
  • Type: string

The name of the backend environment that is part of the Amplify app.

id
  • Required: Yes
  • Type: string

The ID of the theme.

name
  • Required: Yes
  • Type: string

The name of the theme.

ThemeValue

Description

Describes the configuration of a theme's properties.

Members
children
  • Type: Array of ThemeValues structures

A list of key-value pairs that define the theme's properties.

value
  • Type: string

The value of a theme property.

ThemeValues

Description

A key-value pair that defines a property of a theme.

Members
key
  • Type: string

The name of the property.

value
  • Type: ThemeValue structure

The value of the property.

UnauthorizedException

Description

You don't have permission to perform this operation.

Members
message
  • Type: string

UpdateComponentData

Description

Updates and saves all of the information about a component, based on component ID.

Members
bindingProperties
  • Type: Associative array of custom strings keys (String) to ComponentBindingPropertiesValue structures

The data binding information for the component's properties.

children
  • Type: Array of ComponentChild structures

The components that are instances of the main component.

collectionProperties
  • Type: Associative array of custom strings keys (String) to ComponentDataConfiguration structures

The configuration for binding a component's properties to a data model. Use this for a collection component.

componentType
  • Type: string

The type of the component. This can be an Amplify custom UI component or another custom component.

events
  • Type: Associative array of custom strings keys (String) to ComponentEvent structures

The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

id
  • Type: string

The unique ID of the component to update.

name
  • Type: string

The name of the component to update.

overrides
  • Type: Associative array of custom strings keys (String) to stringss

Describes the properties that can be overriden to customize the component.

properties
  • Type: Associative array of custom strings keys (String) to ComponentProperty structures

Describes the component's properties.

schemaVersion
  • Type: string

The schema version of the component when it was imported.

sourceId
  • Type: string

The unique ID of the component in its original source system, such as Figma.

variants
  • Type: Array of ComponentVariant structures

A list of the unique variants of the main component being updated.

UpdateFormData

Description

Updates and saves all of the information about a form, based on form ID.

Members
cta
  • Type: FormCTA structure

The FormCTA object that stores the call to action configuration for the form.

dataType
  • Type: FormDataTypeConfig structure

The type of data source to use to create the form.

fields
  • Type: Associative array of custom strings keys (String) to FieldConfig structures

The configuration information for the form's fields.

formActionType
  • Type: string

Specifies whether to perform a create or update action on the form.

name
  • Type: string

The name of the form.

schemaVersion
  • Type: string

The schema version of the form.

sectionalElements
  • Type: Associative array of custom strings keys (String) to SectionalElement structures

The configuration information for the visual helper elements for the form. These elements are not associated with any data.

style
  • Type: FormStyle structure

The configuration for the form's style.

UpdateThemeData

Description

Saves the data binding information for a theme.

Members
id
  • Type: string

The unique ID of the theme to update.

name
  • Type: string

The name of the theme to update.

overrides
  • Type: Array of ThemeValues structures

Describes the properties that can be overriden to customize the theme.

values
  • Required: Yes
  • Type: Array of ThemeValues structures

A list of key-value pairs that define the theme's properties.

ValueMapping

Description

Associates a complex object with a display value. Use ValueMapping to store how to represent complex objects when they are displayed.

Members
displayValue
  • Type: FormInputValueProperty structure

The value to display for the complex object.

value
  • Required: Yes
  • Type: FormInputValueProperty structure

The complex object.

ValueMappings

Description

Represents the data binding configuration for a value map.

Members
values
  • Required: Yes
  • Type: Array of ValueMapping structures

The value and display value pairs.

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