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

Namespaces

  • Aws
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • Athena
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • Batch
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchLogs
      • Exception
    • CodeBuild
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodePipeline
      • Exception
    • CodeStar
      • Exception
    • CodeStarNotifications
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoIdentityProvider
      • Exception
    • CognitoSync
      • Exception
    • Comprehend
      • Exception
    • ComprehendMedical
      • Exception
    • ConfigService
      • Exception
    • Connect
      • Exception
    • ConnectParticipant
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • DeviceFarm
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • Exception
    • DynamoDb
      • Exception
    • DynamoDbStreams
      • Exception
    • Ec2
      • Exception
    • EC2InstanceConnect
      • Exception
    • Ecr
      • Exception
    • Ecs
      • Exception
    • Efs
      • Exception
    • EKS
      • Exception
    • ElastiCache
      • Exception
    • ElasticBeanstalk
      • Exception
    • ElasticLoadBalancing
      • Exception
    • ElasticLoadBalancingV2
      • Exception
    • ElasticsearchService
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Exception
    • Endpoint
    • EndpointDiscovery
      • Exception
    • EventBridge
      • Exception
    • Exception
    • Firehose
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FSx
      • Exception
    • GameLift
      • Exception
    • Glacier
      • Exception
    • GlobalAccelerator
      • Exception
    • Glue
      • Exception
    • Greengrass
      • Exception
    • GroundStation
      • Exception
    • GuardDuty
      • Exception
    • Handler
      • GuzzleV5
      • GuzzleV6
    • Health
      • Exception
    • Iam
      • Exception
    • ImportExport
      • Exception
    • Inspector
      • Exception
    • Iot
      • Exception
    • IoT1ClickDevicesService
      • Exception
    • IoT1ClickProjects
      • Exception
    • IoTAnalytics
      • Exception
    • IotDataPlane
      • Exception
    • IoTEvents
      • Exception
    • IoTEventsData
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTThingsGraph
      • Exception
    • Kafka
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexRuntimeService
      • Exception
    • LicenseManager
      • Exception
    • Lightsail
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • ManagedBlockchain
      • Exception
    • MarketplaceCatalog
      • Exception
    • MarketplaceCommerceAnalytics
      • Exception
    • MarketplaceEntitlementService
      • Exception
    • MarketplaceMetering
      • Exception
    • MediaConnect
      • Exception
    • MediaConvert
      • Exception
    • MediaLive
      • Exception
    • MediaPackage
      • Exception
    • MediaPackageVod
      • Exception
    • MediaStore
      • Exception
    • MediaStoreData
      • Exception
    • MediaTailor
      • Exception
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • Neptune
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • Redshift
      • Exception
    • Rekognition
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • RoboMaker
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • Exception
    • Route53Resolver
      • Exception
    • S3
      • Crypto
      • Exception
      • RegionalEndpoint
        • Exception
    • S3Control
      • Exception
    • SageMaker
      • Exception
    • SageMakerRuntime
      • Exception
    • SavingsPlans
      • Exception
    • SecretsManager
      • Exception
    • SecurityHub
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • ServiceQuotas
      • Exception
    • Ses
      • Exception
    • SesV2
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • signer
      • Exception
    • Sms
      • Exception
    • SnowBall
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSO
      • Exception
    • SSOOIDC
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
      • RegionalEndpoints
        • Exception
    • Support
      • Exception
    • Swf
      • Exception
    • Textract
      • Exception
    • TranscribeService
      • Exception
    • Transfer
      • Exception
    • Translate
      • Exception
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • 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\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\Appstream\AppstreamClient
  • Aws\AppSync\AppSyncClient
  • Aws\Athena\AthenaClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Backup\BackupClient
  • Aws\Batch\BatchClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudDirectory\CloudDirectoryClient
  • Aws\CloudFormation\CloudFormationClient
  • Aws\CloudFront\CloudFrontClient
  • Aws\CloudFront\CookieSigner
  • Aws\CloudFront\UrlSigner
  • Aws\CloudHsm\CloudHsmClient
  • Aws\CloudHSMV2\CloudHSMV2Client
  • Aws\CloudSearch\CloudSearchClient
  • Aws\CloudSearchDomain\CloudSearchDomainClient
  • Aws\CloudTrail\CloudTrailClient
  • Aws\CloudTrail\LogFileIterator
  • Aws\CloudTrail\LogFileReader
  • Aws\CloudTrail\LogRecordIterator
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCommit\CodeCommitClient
  • Aws\CodeDeploy\CodeDeployClient
  • Aws\CodePipeline\CodePipelineClient
  • Aws\CodeStar\CodeStarClient
  • 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\ConfigService\ConfigServiceClient
  • Aws\Connect\ConnectClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\CostandUsageReportService\CostandUsageReportServiceClient
  • Aws\CostExplorer\CostExplorerClient
  • Aws\Credentials\AssumeRoleCredentialProvider
  • Aws\Credentials\AssumeRoleWithWebIdentityCredentialProvider
  • Aws\Credentials\CredentialProvider
  • Aws\Credentials\Credentials
  • Aws\Credentials\EcsCredentialProvider
  • Aws\Credentials\InstanceProfileProvider
  • Aws\Crypto\AesDecryptingStream
  • Aws\Crypto\AesEncryptingStream
  • Aws\Crypto\AesGcmDecryptingStream
  • Aws\Crypto\AesGcmEncryptingStream
  • Aws\Crypto\Cipher\Cbc
  • Aws\Crypto\KmsMaterialsProvider
  • Aws\Crypto\MaterialsProvider
  • Aws\DatabaseMigrationService\DatabaseMigrationServiceClient
  • Aws\DataExchange\DataExchangeClient
  • Aws\DataPipeline\DataPipelineClient
  • Aws\DataSync\DataSyncClient
  • Aws\DAX\DAXClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DoctrineCacheAdapter
  • Aws\DynamoDb\BinaryValue
  • Aws\DynamoDb\DynamoDbClient
  • Aws\DynamoDb\LockingSessionConnection
  • Aws\DynamoDb\Marshaler
  • Aws\DynamoDb\NumberValue
  • Aws\DynamoDb\SessionHandler
  • Aws\DynamoDb\SetValue
  • Aws\DynamoDb\StandardSessionConnection
  • Aws\DynamoDb\WriteRequestBatch
  • Aws\DynamoDbStreams\DynamoDbStreamsClient
  • Aws\Ec2\Ec2Client
  • Aws\EC2InstanceConnect\EC2InstanceConnectClient
  • Aws\Ecr\EcrClient
  • Aws\Ecs\EcsClient
  • Aws\Efs\EfsClient
  • Aws\EKS\EKSClient
  • Aws\ElastiCache\ElastiCacheClient
  • Aws\ElasticBeanstalk\ElasticBeanstalkClient
  • Aws\ElasticLoadBalancing\ElasticLoadBalancingClient
  • Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client
  • Aws\ElasticsearchService\ElasticsearchServiceClient
  • Aws\ElasticTranscoder\ElasticTranscoderClient
  • Aws\Emr\EmrClient
  • Aws\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EventBridge\EventBridgeClient
  • Aws\Firehose\FirehoseClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • Aws\Glacier\GlacierClient
  • Aws\Glacier\MultipartUploader
  • Aws\Glacier\TreeHash
  • Aws\GlobalAccelerator\GlobalAcceleratorClient
  • Aws\Glue\GlueClient
  • Aws\Greengrass\GreengrassClient
  • 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\History
  • Aws\Iam\IamClient
  • Aws\IdempotencyTokenMiddleware
  • Aws\ImportExport\ImportExportClient
  • Aws\Inspector\InspectorClient
  • Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient
  • Aws\IoT1ClickProjects\IoT1ClickProjectsClient
  • Aws\Iot\IotClient
  • Aws\IoTAnalytics\IoTAnalyticsClient
  • Aws\IotDataPlane\IotDataPlaneClient
  • Aws\IoTEvents\IoTEventsClient
  • Aws\IoTEventsData\IoTEventsDataClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\Kinesis\KinesisClient
  • Aws\KinesisAnalytics\KinesisAnalyticsClient
  • Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client
  • Aws\KinesisVideo\KinesisVideoClient
  • Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
  • Aws\KinesisVideoMedia\KinesisVideoMediaClient
  • Aws\Kms\KmsClient
  • Aws\LakeFormation\LakeFormationClient
  • Aws\Lambda\LambdaClient
  • Aws\LexModelBuildingService\LexModelBuildingServiceClient
  • Aws\LexRuntimeService\LexRuntimeServiceClient
  • Aws\LicenseManager\LicenseManagerClient
  • Aws\Lightsail\LightsailClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie\MacieClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • Aws\MarketplaceCatalog\MarketplaceCatalogClient
  • Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient
  • Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient
  • Aws\MarketplaceMetering\MarketplaceMeteringClient
  • Aws\MediaConnect\MediaConnectClient
  • Aws\MediaConvert\MediaConvertClient
  • Aws\MediaLive\MediaLiveClient
  • Aws\MediaPackage\MediaPackageClient
  • Aws\MediaPackageVod\MediaPackageVodClient
  • Aws\MediaStore\MediaStoreClient
  • Aws\MediaStoreData\MediaStoreDataClient
  • Aws\MediaTailor\MediaTailorClient
  • Aws\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • Aws\Mobile\MobileClient
  • Aws\MockHandler
  • Aws\MQ\MQClient
  • Aws\MTurk\MTurkClient
  • Aws\Multipart\UploadState
  • Aws\MultiRegionClient
  • Aws\Neptune\NeptuneClient
  • Aws\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\Psr16CacheAdapter
  • Aws\PsrCacheAdapter
  • Aws\QLDB\QLDBClient
  • Aws\QLDBSession\QLDBSessionClient
  • Aws\QuickSight\QuickSightClient
  • Aws\RAM\RAMClient
  • Aws\Rds\AuthTokenGenerator
  • Aws\Rds\RdsClient
  • Aws\RDSDataService\RDSDataServiceClient
  • Aws\Redshift\RedshiftClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\RetryMiddleware
  • Aws\RoboMaker\RoboMakerClient
  • Aws\Route53\Route53Client
  • Aws\Route53Domains\Route53DomainsClient
  • Aws\Route53Resolver\Route53ResolverClient
  • Aws\S3\BatchDelete
  • Aws\S3\Crypto\HeadersMetadataStrategy
  • Aws\S3\Crypto\InstructionFileMetadataStrategy
  • Aws\S3\Crypto\S3EncryptionClient
  • Aws\S3\Crypto\S3EncryptionMultipartUploader
  • 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\S3Control\S3ControlClient
  • Aws\SageMaker\SageMakerClient
  • Aws\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\SavingsPlans\SavingsPlansClient
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\SecurityHub\SecurityHubClient
  • Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
  • Aws\ServiceCatalog\ServiceCatalogClient
  • Aws\ServiceDiscovery\ServiceDiscoveryClient
  • Aws\ServiceQuotas\ServiceQuotasClient
  • Aws\Ses\SesClient
  • Aws\SesV2\SesV2Client
  • Aws\Sfn\SfnClient
  • Aws\Shield\ShieldClient
  • Aws\Signature\AnonymousSignature
  • Aws\Signature\S3SignatureV4
  • Aws\Signature\SignatureProvider
  • Aws\Signature\SignatureV4
  • Aws\signer\signerClient
  • Aws\Sms\SmsClient
  • Aws\SnowBall\SnowBallClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSO\SSOClient
  • Aws\SSOOIDC\SSOOIDCClient
  • Aws\StorageGateway\StorageGatewayClient
  • Aws\Sts\RegionalEndpoints\Configuration
  • Aws\Sts\RegionalEndpoints\ConfigurationProvider
  • Aws\Sts\StsClient
  • Aws\Support\SupportClient
  • Aws\Swf\SwfClient
  • Aws\Textract\TextractClient
  • Aws\TraceMiddleware
  • Aws\TranscribeService\TranscribeServiceClient
  • Aws\Transfer\TransferClient
  • Aws\Translate\TranslateClient
  • Aws\Waf\WafClient
  • Aws\WafRegional\WafRegionalClient
  • Aws\WAFV2\WAFV2Client
  • Aws\Waiter
  • Aws\WorkDocs\WorkDocsClient
  • Aws\WorkLink\WorkLinkClient
  • Aws\WorkMail\WorkMailClient
  • Aws\WorkMailMessageFlow\WorkMailMessageFlowClient
  • Aws\WorkSpaces\WorkSpacesClient
  • Aws\WrappedHttpHandler
  • Aws\XRay\XRayClient

Interfaces

  • Aws\AwsClientInterface
  • Aws\CacheInterface
  • Aws\ClientSideMonitoring\ConfigurationInterface
  • Aws\CommandInterface
  • Aws\ConfigurationProviderInterface
  • Aws\Credentials\CredentialsInterface
  • Aws\Crypto\AesStreamInterface
  • Aws\Crypto\Cipher\CipherMethod
  • Aws\Crypto\MetadataStrategyInterface
  • Aws\DynamoDb\SessionConnectionInterface
  • Aws\Endpoint\PartitionInterface
  • Aws\EndpointDiscovery\ConfigurationInterface
  • Aws\HashInterface
  • Aws\MonitoringEventsInterface
  • Aws\ResponseContainerInterface
  • Aws\ResultInterface
  • Aws\S3\RegionalEndpoint\ConfigurationInterface
  • Aws\S3\S3ClientInterface
  • Aws\Signature\SignatureInterface
  • Aws\Sts\RegionalEndpoints\ConfigurationInterface

Traits

  • Aws\Api\ErrorParser\JsonParserTrait
  • Aws\Api\Parser\MetadataParserTrait
  • Aws\Api\Parser\PayloadParserTrait
  • Aws\AwsClientTrait
  • Aws\Crypto\Cipher\CipherBuilderTrait
  • Aws\Crypto\DecryptionTrait
  • Aws\Crypto\EncryptionTrait
  • Aws\DynamoDb\SessionConnectionConfigTrait
  • Aws\HasDataTrait
  • Aws\HasMonitoringEventsTrait
  • Aws\S3\Crypto\CryptoParamsTrait
  • Aws\S3\MultipartUploadingTrait
  • Aws\S3\S3ClientTrait
  • Aws\Signature\SignatureTrait

Exceptions

  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\Appstream\Exception\AppstreamException
  • Aws\AppSync\Exception\AppSyncException
  • Aws\Athena\Exception\AthenaException
  • Aws\AutoScaling\Exception\AutoScalingException
  • Aws\AutoScalingPlans\Exception\AutoScalingPlansException
  • Aws\Backup\Exception\BackupException
  • Aws\Batch\Exception\BatchException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • Aws\Cloud9\Exception\Cloud9Exception
  • Aws\CloudDirectory\Exception\CloudDirectoryException
  • Aws\CloudFormation\Exception\CloudFormationException
  • Aws\CloudFront\Exception\CloudFrontException
  • Aws\CloudHsm\Exception\CloudHsmException
  • Aws\CloudHSMV2\Exception\CloudHSMV2Exception
  • Aws\CloudSearch\Exception\CloudSearchException
  • Aws\CloudSearchDomain\Exception\CloudSearchDomainException
  • Aws\CloudTrail\Exception\CloudTrailException
  • Aws\CloudWatch\Exception\CloudWatchException
  • Aws\CloudWatchEvents\Exception\CloudWatchEventsException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CodeBuild\Exception\CodeBuildException
  • Aws\CodeCommit\Exception\CodeCommitException
  • Aws\CodeDeploy\Exception\CodeDeployException
  • Aws\CodePipeline\Exception\CodePipelineException
  • Aws\CodeStar\Exception\CodeStarException
  • 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\ConfigService\Exception\ConfigServiceException
  • Aws\Connect\Exception\ConnectException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\CostandUsageReportService\Exception\CostandUsageReportServiceException
  • Aws\CostExplorer\Exception\CostExplorerException
  • Aws\DatabaseMigrationService\Exception\DatabaseMigrationServiceException
  • Aws\DataExchange\Exception\DataExchangeException
  • Aws\DataPipeline\Exception\DataPipelineException
  • Aws\DataSync\Exception\DataSyncException
  • Aws\DAX\Exception\DAXException
  • Aws\DeviceFarm\Exception\DeviceFarmException
  • Aws\DirectConnect\Exception\DirectConnectException
  • Aws\DirectoryService\Exception\DirectoryServiceException
  • Aws\DLM\Exception\DLMException
  • Aws\DocDB\Exception\DocDBException
  • Aws\DynamoDb\Exception\DynamoDbException
  • Aws\DynamoDbStreams\Exception\DynamoDbStreamsException
  • Aws\Ec2\Exception\Ec2Exception
  • Aws\EC2InstanceConnect\Exception\EC2InstanceConnectException
  • Aws\Ecr\Exception\EcrException
  • Aws\Ecs\Exception\EcsException
  • Aws\Efs\Exception\EfsException
  • Aws\EKS\Exception\EKSException
  • Aws\ElastiCache\Exception\ElastiCacheException
  • Aws\ElasticBeanstalk\Exception\ElasticBeanstalkException
  • Aws\ElasticLoadBalancing\Exception\ElasticLoadBalancingException
  • Aws\ElasticLoadBalancingV2\Exception\ElasticLoadBalancingV2Exception
  • Aws\ElasticsearchService\Exception\ElasticsearchServiceException
  • Aws\ElasticTranscoder\Exception\ElasticTranscoderException
  • Aws\Emr\Exception\EmrException
  • Aws\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • Aws\Exception\CouldNotCreateChecksumException
  • Aws\Exception\CredentialsException
  • Aws\Exception\EventStreamDataException
  • Aws\Exception\IncalculablePayloadException
  • Aws\Exception\InvalidJsonException
  • Aws\Exception\MultipartUploadException
  • Aws\Exception\UnresolvedApiException
  • Aws\Exception\UnresolvedEndpointException
  • Aws\Exception\UnresolvedSignatureException
  • Aws\Firehose\Exception\FirehoseException
  • Aws\FMS\Exception\FMSException
  • Aws\ForecastQueryService\Exception\ForecastQueryServiceException
  • Aws\ForecastService\Exception\ForecastServiceException
  • Aws\FSx\Exception\FSxException
  • Aws\GameLift\Exception\GameLiftException
  • Aws\Glacier\Exception\GlacierException
  • Aws\GlobalAccelerator\Exception\GlobalAcceleratorException
  • Aws\Glue\Exception\GlueException
  • Aws\Greengrass\Exception\GreengrassException
  • Aws\GroundStation\Exception\GroundStationException
  • Aws\GuardDuty\Exception\GuardDutyException
  • Aws\Health\Exception\HealthException
  • Aws\Iam\Exception\IamException
  • Aws\ImportExport\Exception\ImportExportException
  • Aws\Inspector\Exception\InspectorException
  • Aws\IoT1ClickDevicesService\Exception\IoT1ClickDevicesServiceException
  • Aws\IoT1ClickProjects\Exception\IoT1ClickProjectsException
  • Aws\Iot\Exception\IotException
  • Aws\IoTAnalytics\Exception\IoTAnalyticsException
  • Aws\IotDataPlane\Exception\IotDataPlaneException
  • Aws\IoTEvents\Exception\IoTEventsException
  • Aws\IoTEventsData\Exception\IoTEventsDataException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTSecureTunneling\Exception\IoTSecureTunnelingException
  • Aws\IoTThingsGraph\Exception\IoTThingsGraphException
  • Aws\Kafka\Exception\KafkaException
  • 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\Kms\Exception\KmsException
  • Aws\LakeFormation\Exception\LakeFormationException
  • Aws\Lambda\Exception\LambdaException
  • Aws\LexModelBuildingService\Exception\LexModelBuildingServiceException
  • Aws\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\LicenseManager\Exception\LicenseManagerException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie\Exception\MacieException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • Aws\MarketplaceCatalog\Exception\MarketplaceCatalogException
  • Aws\MarketplaceCommerceAnalytics\Exception\MarketplaceCommerceAnalyticsException
  • Aws\MarketplaceEntitlementService\Exception\MarketplaceEntitlementServiceException
  • Aws\MarketplaceMetering\Exception\MarketplaceMeteringException
  • Aws\MediaConnect\Exception\MediaConnectException
  • Aws\MediaConvert\Exception\MediaConvertException
  • Aws\MediaLive\Exception\MediaLiveException
  • Aws\MediaPackage\Exception\MediaPackageException
  • Aws\MediaPackageVod\Exception\MediaPackageVodException
  • Aws\MediaStore\Exception\MediaStoreException
  • Aws\MediaStoreData\Exception\MediaStoreDataException
  • Aws\MediaTailor\Exception\MediaTailorException
  • Aws\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • Aws\Mobile\Exception\MobileException
  • Aws\MQ\Exception\MQException
  • Aws\MTurk\Exception\MTurkException
  • Aws\Neptune\Exception\NeptuneException
  • Aws\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Personalize\Exception\PersonalizeException
  • Aws\PersonalizeEvents\Exception\PersonalizeEventsException
  • Aws\PersonalizeRuntime\Exception\PersonalizeRuntimeException
  • Aws\PI\Exception\PIException
  • Aws\Pinpoint\Exception\PinpointException
  • Aws\PinpointEmail\Exception\PinpointEmailException
  • Aws\PinpointSMSVoice\Exception\PinpointSMSVoiceException
  • Aws\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\QLDB\Exception\QLDBException
  • Aws\QLDBSession\Exception\QLDBSessionException
  • Aws\QuickSight\Exception\QuickSightException
  • Aws\RAM\Exception\RAMException
  • Aws\Rds\Exception\RdsException
  • Aws\RDSDataService\Exception\RDSDataServiceException
  • Aws\Redshift\Exception\RedshiftException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\RoboMaker\Exception\RoboMakerException
  • Aws\Route53\Exception\Route53Exception
  • Aws\Route53Domains\Exception\Route53DomainsException
  • Aws\Route53Resolver\Exception\Route53ResolverException
  • Aws\S3\Exception\DeleteMultipleObjectsException
  • Aws\S3\Exception\PermanentRedirectException
  • Aws\S3\Exception\S3Exception
  • Aws\S3\Exception\S3MultipartUploadException
  • Aws\S3\RegionalEndpoint\Exception\ConfigurationException
  • Aws\S3Control\Exception\S3ControlException
  • Aws\SageMaker\Exception\SageMakerException
  • Aws\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SavingsPlans\Exception\SavingsPlansException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\SecurityHub\Exception\SecurityHubException
  • Aws\ServerlessApplicationRepository\Exception\ServerlessApplicationRepositoryException
  • Aws\ServiceCatalog\Exception\ServiceCatalogException
  • Aws\ServiceDiscovery\Exception\ServiceDiscoveryException
  • Aws\ServiceQuotas\Exception\ServiceQuotasException
  • Aws\Ses\Exception\SesException
  • Aws\SesV2\Exception\SesV2Exception
  • Aws\Sfn\Exception\SfnException
  • Aws\Shield\Exception\ShieldException
  • Aws\signer\Exception\signerException
  • Aws\Sms\Exception\SmsException
  • Aws\SnowBall\Exception\SnowBallException
  • Aws\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\SSO\Exception\SSOException
  • Aws\SSOOIDC\Exception\SSOOIDCException
  • Aws\StorageGateway\Exception\StorageGatewayException
  • Aws\Sts\Exception\StsException
  • Aws\Sts\RegionalEndpoints\Exception\ConfigurationException
  • Aws\Support\Exception\SupportException
  • Aws\Swf\Exception\SwfException
  • Aws\Textract\Exception\TextractException
  • Aws\TranscribeService\Exception\TranscribeServiceException
  • Aws\Transfer\Exception\TransferException
  • Aws\Translate\Exception\TranslateException
  • Aws\Waf\Exception\WafException
  • Aws\WafRegional\Exception\WafRegionalException
  • Aws\WAFV2\Exception\WAFV2Exception
  • Aws\WorkDocs\Exception\WorkDocsException
  • Aws\WorkLink\Exception\WorkLinkException
  • Aws\WorkMail\Exception\WorkMailException
  • Aws\WorkMailMessageFlow\Exception\WorkMailMessageFlowException
  • Aws\WorkSpaces\Exception\WorkSpacesException
  • Aws\XRay\Exception\XRayException

Functions

  • Aws\clear_compiled_json
  • Aws\constantly
  • Aws\default_http_handler
  • Aws\default_user_agent
  • Aws\describe_type
  • Aws\dir_iterator
  • Aws\filter
  • Aws\flatmap
  • 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 services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Amazon API Gateway 2015-07-09

Client: Aws\ApiGateway\ApiGatewayClient
Service ID: apigateway
Version: 2015-07-09

This page describes the parameters and results for the operations of the Amazon API Gateway (2015-07-09), and shows how to use the Aws\ApiGateway\ApiGatewayClient object to call the described operations. This documentation is specific to the 2015-07-09 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 */).

  • CreateApiKey ( array $params = [] )

    Create an ApiKey resource.

  • CreateAuthorizer ( array $params = [] )

    Adds a new Authorizer resource to an existing RestApi resource.

  • CreateBasePathMapping ( array $params = [] )

    Creates a new BasePathMapping resource.

  • CreateDeployment ( array $params = [] )

    Creates a Deployment resource, which makes a specified RestApi callable over the internet.

  • CreateDocumentationPart ( array $params = [] )
  • CreateDocumentationVersion ( array $params = [] )
  • CreateDomainName ( array $params = [] )

    Creates a new domain name.

  • CreateModel ( array $params = [] )

    Adds a new Model resource to an existing RestApi resource.

  • CreateRequestValidator ( array $params = [] )

    Creates a ReqeustValidator of a given RestApi.

  • CreateResource ( array $params = [] )

    Creates a Resource resource.

  • CreateRestApi ( array $params = [] )

    Creates a new RestApi resource.

  • CreateStage ( array $params = [] )

    Creates a new Stage resource that references a pre-existing Deployment for the API.

  • CreateUsagePlan ( array $params = [] )

    Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

  • CreateUsagePlanKey ( array $params = [] )

    Creates a usage plan key for adding an existing API key to a usage plan.

  • CreateVpcLink ( array $params = [] )

    Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational.

  • DeleteApiKey ( array $params = [] )

    Deletes the ApiKey resource.

  • DeleteAuthorizer ( array $params = [] )

    Deletes an existing Authorizer resource.

  • DeleteBasePathMapping ( array $params = [] )

    Deletes the BasePathMapping resource.

  • DeleteClientCertificate ( array $params = [] )

    Deletes the ClientCertificate resource.

  • DeleteDeployment ( array $params = [] )

    Deletes a Deployment resource.

  • DeleteDocumentationPart ( array $params = [] )
  • DeleteDocumentationVersion ( array $params = [] )
  • DeleteDomainName ( array $params = [] )

    Deletes the DomainName resource.

  • DeleteGatewayResponse ( array $params = [] )

    Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

  • DeleteIntegration ( array $params = [] )

    Represents a delete integration.

  • DeleteIntegrationResponse ( array $params = [] )

    Represents a delete integration response.

  • DeleteMethod ( array $params = [] )

    Deletes an existing Method resource.

  • DeleteMethodResponse ( array $params = [] )

    Deletes an existing MethodResponse resource.

  • DeleteModel ( array $params = [] )

    Deletes a model.

  • DeleteRequestValidator ( array $params = [] )

    Deletes a RequestValidator of a given RestApi.

  • DeleteResource ( array $params = [] )

    Deletes a Resource resource.

  • DeleteRestApi ( array $params = [] )

    Deletes the specified API.

  • DeleteStage ( array $params = [] )

    Deletes a Stage resource.

  • DeleteUsagePlan ( array $params = [] )

    Deletes a usage plan of a given plan Id.

  • DeleteUsagePlanKey ( array $params = [] )

    Deletes a usage plan key and remove the underlying API key from the associated usage plan.

  • DeleteVpcLink ( array $params = [] )

    Deletes an existing VpcLink of a specified identifier.

  • FlushStageAuthorizersCache ( array $params = [] )

    Flushes all authorizer cache entries on a stage.

  • FlushStageCache ( array $params = [] )

    Flushes a stage's cache.

  • GenerateClientCertificate ( array $params = [] )

    Generates a ClientCertificate resource.

  • GetAccount ( array $params = [] )

    Gets information about the current Account resource.

  • GetApiKey ( array $params = [] )

    Gets information about the current ApiKey resource.

  • GetApiKeys ( array $params = [] )

    Gets information about the current ApiKeys resource.

  • GetAuthorizer ( array $params = [] )

    Describe an existing Authorizer resource.

  • GetAuthorizers ( array $params = [] )

    Describe an existing Authorizers resource.

  • GetBasePathMapping ( array $params = [] )

    Describe a BasePathMapping resource.

  • GetBasePathMappings ( array $params = [] )

    Represents a collection of BasePathMapping resources.

  • GetClientCertificate ( array $params = [] )

    Gets information about the current ClientCertificate resource.

  • GetClientCertificates ( array $params = [] )

    Gets a collection of ClientCertificate resources.

  • GetDeployment ( array $params = [] )

    Gets information about a Deployment resource.

  • GetDeployments ( array $params = [] )

    Gets information about a Deployments collection.

  • GetDocumentationPart ( array $params = [] )
  • GetDocumentationParts ( array $params = [] )
  • GetDocumentationVersion ( array $params = [] )
  • GetDocumentationVersions ( array $params = [] )
  • GetDomainName ( array $params = [] )

    Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

  • GetDomainNames ( array $params = [] )

    Represents a collection of DomainName resources.

  • GetExport ( array $params = [] )

    Exports a deployed version of a RestApi in a specified format.

  • GetGatewayResponse ( array $params = [] )

    Gets a GatewayResponse of a specified response type on the given RestApi.

  • GetGatewayResponses ( array $params = [] )

    Gets the GatewayResponses collection on the given RestApi.

  • GetIntegration ( array $params = [] )

    Get the integration settings.

  • GetIntegrationResponse ( array $params = [] )

    Represents a get integration response.

  • GetMethod ( array $params = [] )

    Describe an existing Method resource.

  • GetMethodResponse ( array $params = [] )

    Describes a MethodResponse resource.

  • GetModel ( array $params = [] )

    Describes an existing model defined for a RestApi resource.

  • GetModelTemplate ( array $params = [] )

    Generates a sample mapping template that can be used to transform a payload into the structure of a model.

  • GetModels ( array $params = [] )

    Describes existing Models defined for a RestApi resource.

  • GetRequestValidator ( array $params = [] )

    Gets a RequestValidator of a given RestApi.

  • GetRequestValidators ( array $params = [] )

    Gets the RequestValidators collection of a given RestApi.

  • GetResource ( array $params = [] )

    Lists information about a resource.

  • GetResources ( array $params = [] )

    Lists information about a collection of Resource resources.

  • GetRestApi ( array $params = [] )

    Lists the RestApi resource in the collection.

  • GetRestApis ( array $params = [] )

    Lists the RestApis resources for your collection.

  • GetSdk ( array $params = [] )

    Generates a client SDK for a RestApi and Stage.

  • GetSdkType ( array $params = [] )
  • GetSdkTypes ( array $params = [] )
  • GetStage ( array $params = [] )

    Gets information about a Stage resource.

  • GetStages ( array $params = [] )

    Gets information about one or more Stage resources.

  • GetTags ( array $params = [] )

    Gets the Tags collection for a given resource.

  • GetUsage ( array $params = [] )

    Gets the usage data of a usage plan in a specified time interval.

  • GetUsagePlan ( array $params = [] )

    Gets a usage plan of a given plan identifier.

  • GetUsagePlanKey ( array $params = [] )

    Gets a usage plan key of a given key identifier.

  • GetUsagePlanKeys ( array $params = [] )

    Gets all the usage plan keys representing the API keys added to a specified usage plan.

  • GetUsagePlans ( array $params = [] )

    Gets all the usage plans of the caller's account.

  • GetVpcLink ( array $params = [] )

    Gets a specified VPC link under the caller's account in a region.

  • GetVpcLinks ( array $params = [] )

    Gets the VpcLinks collection under the caller's account in a selected region.

  • ImportApiKeys ( array $params = [] )

    Import API keys from an external source, such as a CSV-formatted file.

  • ImportDocumentationParts ( array $params = [] )
  • ImportRestApi ( array $params = [] )

    A feature of the API Gateway control service for creating a new API from an external API definition file.

  • PutGatewayResponse ( array $params = [] )

    Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

  • PutIntegration ( array $params = [] )

    Sets up a method's integration.

  • PutIntegrationResponse ( array $params = [] )

    Represents a put integration.

  • PutMethod ( array $params = [] )

    Add a method to an existing Resource resource.

  • PutMethodResponse ( array $params = [] )

    Adds a MethodResponse to an existing Method resource.

  • PutRestApi ( array $params = [] )

    A feature of the API Gateway control service for updating an existing API with an input of external API definitions.

  • TagResource ( array $params = [] )

    Adds or updates a tag on a given resource.

  • TestInvokeAuthorizer ( array $params = [] )

    Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

  • TestInvokeMethod ( array $params = [] )

    Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.

  • UntagResource ( array $params = [] )

    Removes a tag from a given resource.

  • UpdateAccount ( array $params = [] )

    Changes information about the current Account resource.

  • UpdateApiKey ( array $params = [] )

    Changes information about an ApiKey resource.

  • UpdateAuthorizer ( array $params = [] )

    Updates an existing Authorizer resource.

  • UpdateBasePathMapping ( array $params = [] )

    Changes information about the BasePathMapping resource.

  • UpdateClientCertificate ( array $params = [] )

    Changes information about an ClientCertificate resource.

  • UpdateDeployment ( array $params = [] )

    Changes information about a Deployment resource.

  • UpdateDocumentationPart ( array $params = [] )
  • UpdateDocumentationVersion ( array $params = [] )
  • UpdateDomainName ( array $params = [] )

    Changes information about the DomainName resource.

  • UpdateGatewayResponse ( array $params = [] )

    Updates a GatewayResponse of a specified response type on the given RestApi.

  • UpdateIntegration ( array $params = [] )

    Represents an update integration.

  • UpdateIntegrationResponse ( array $params = [] )

    Represents an update integration response.

  • UpdateMethod ( array $params = [] )

    Updates an existing Method resource.

  • UpdateMethodResponse ( array $params = [] )

    Updates an existing MethodResponse resource.

  • UpdateModel ( array $params = [] )

    Changes information about a model.

  • UpdateRequestValidator ( array $params = [] )

    Updates a RequestValidator of a given RestApi.

  • UpdateResource ( array $params = [] )

    Changes information about a Resource resource.

  • UpdateRestApi ( array $params = [] )

    Changes information about the specified API.

  • UpdateStage ( array $params = [] )

    Changes information about a Stage resource.

  • UpdateUsage ( array $params = [] )

    Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

  • UpdateUsagePlan ( array $params = [] )

    Updates a usage plan of a given plan Id.

  • UpdateVpcLink ( array $params = [] )

    Updates an existing VpcLink of a specified identifier.

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:

  • GetApiKeys
  • GetBasePathMappings
  • GetClientCertificates
  • GetDeployments
  • GetDomainNames
  • GetModels
  • GetResources
  • GetRestApis
  • GetUsage
  • GetUsagePlanKeys
  • GetUsagePlans
  • GetVpcLinks

Operations

CreateApiKey

$result = $client->createApiKey([/* ... */]);
$promise = $client->createApiKeyAsync([/* ... */]);

Create an ApiKey resource.

AWS CLI

Parameter Syntax

$result = $client->createApiKey([
    'customerId' => '<string>',
    'description' => '<string>',
    'enabled' => true || false,
    'generateDistinctId' => true || false,
    'name' => '<string>',
    'stageKeys' => [
        [
            'restApiId' => '<string>',
            'stageName' => '<string>',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
    'value' => '<string>',
]);

Parameter Details

Members
customerId
  • Type: string

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

description
  • Type: string

The description of the ApiKey.

enabled
  • Type: boolean

Specifies whether the ApiKey can be used by callers.

generateDistinctId
  • Type: boolean

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

name
  • Type: string

The name of the ApiKey.

stageKeys
  • Type: Array of StageKey structures

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

value
  • Type: string

Specifies a value of the API key.

Result Syntax

[
    'createdDate' => <DateTime>,
    'customerId' => '<string>',
    'description' => '<string>',
    'enabled' => true || false,
    'id' => '<string>',
    'lastUpdatedDate' => <DateTime>,
    'name' => '<string>',
    'stageKeys' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'value' => '<string>',
]

Result Details

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

The timestamp when the API Key was created.

customerId
  • Type: string

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

description
  • Type: string

The description of the API Key.

enabled
  • Type: boolean

Specifies whether the API Key can be used by callers.

id
  • Type: string

The identifier of the API Key.

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

The timestamp when the API Key was last updated.

name
  • Type: string

The name of the API Key.

stageKeys
  • Type: Array of strings

A list of Stage resources that are associated with the ApiKey resource.

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

The collection of tags. Each tag element is associated with a given resource.

value
  • Type: string

The value of the API Key.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

CreateAuthorizer

$result = $client->createAuthorizer([/* ... */]);
$promise = $client->createAuthorizerAsync([/* ... */]);

Adds a new Authorizer resource to an existing RestApi resource.

AWS CLI

Parameter Syntax

$result = $client->createAuthorizer([
    'authType' => '<string>',
    'authorizerCredentials' => '<string>',
    'authorizerResultTtlInSeconds' => <integer>,
    'authorizerUri' => '<string>',
    'identitySource' => '<string>',
    'identityValidationExpression' => '<string>',
    'name' => '<string>', // REQUIRED
    'providerARNs' => ['<string>', ...],
    'restApiId' => '<string>', // REQUIRED
    'type' => 'TOKEN|REQUEST|COGNITO_USER_POOLS', // REQUIRED
]);

Parameter Details

Members
authType
  • Type: string

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

authorizerCredentials
  • Type: string

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

authorizerResultTtlInSeconds
  • Type: int

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

authorizerUri
  • Type: string

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

identitySource
  • Type: string

The identity source for which authorization is requested.

  • For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
  • For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

identityValidationExpression
  • Type: string

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

name
  • Required: Yes
  • Type: string

[Required] The name of the authorizer.

providerARNs
  • Type: Array of strings

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

type
  • Required: Yes
  • Type: string

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Result Syntax

[
    'authType' => '<string>',
    'authorizerCredentials' => '<string>',
    'authorizerResultTtlInSeconds' => <integer>,
    'authorizerUri' => '<string>',
    'id' => '<string>',
    'identitySource' => '<string>',
    'identityValidationExpression' => '<string>',
    'name' => '<string>',
    'providerARNs' => ['<string>', ...],
    'type' => 'TOKEN|REQUEST|COGNITO_USER_POOLS',
]

Result Details

Members
authType
  • Type: string

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

authorizerCredentials
  • Type: string

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

authorizerResultTtlInSeconds
  • Type: int

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

authorizerUri
  • Type: string

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

id
  • Type: string

The identifier for the authorizer resource.

identitySource
  • Type: string

The identity source for which authorization is requested.

  • For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
  • For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

identityValidationExpression
  • Type: string

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

name
  • Type: string

[Required] The name of the authorizer.

providerARNs
  • Type: Array of strings

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

type
  • Type: string

The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

CreateBasePathMapping

$result = $client->createBasePathMapping([/* ... */]);
$promise = $client->createBasePathMappingAsync([/* ... */]);

Creates a new BasePathMapping resource.

Parameter Syntax

$result = $client->createBasePathMapping([
    'basePath' => '<string>',
    'domainName' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
    'stage' => '<string>',
]);

Parameter Details

Members
basePath
  • Type: string

The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.

domainName
  • Required: Yes
  • Type: string

[Required] The domain name of the BasePathMapping resource to create.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

stage
  • Type: string

The name of the API's stage that you want to use for this mapping. Specify '(none)' if you do not want callers to explicitly specify the stage name after any base path name.

Result Syntax

[
    'basePath' => '<string>',
    'restApiId' => '<string>',
    'stage' => '<string>',
]

Result Details

Members
basePath
  • Type: string

The base path name that callers of the API must provide as part of the URL after the domain name.

restApiId
  • Type: string

The string identifier of the associated RestApi.

stage
  • Type: string

The name of the associated stage.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

CreateDeployment

$result = $client->createDeployment([/* ... */]);
$promise = $client->createDeploymentAsync([/* ... */]);

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

Parameter Syntax

$result = $client->createDeployment([
    'cacheClusterEnabled' => true || false,
    'cacheClusterSize' => '0.5|1.6|6.1|13.5|28.4|58.2|118|237',
    'canarySettings' => [
        'percentTraffic' => <float>,
        'stageVariableOverrides' => ['<string>', ...],
        'useStageCache' => true || false,
    ],
    'description' => '<string>',
    'restApiId' => '<string>', // REQUIRED
    'stageDescription' => '<string>',
    'stageName' => '<string>',
    'tracingEnabled' => true || false,
    'variables' => ['<string>', ...],
]);

Parameter Details

Members
cacheClusterEnabled
  • Type: boolean

Enables a cache cluster for the Stage resource specified in the input.

cacheClusterSize
  • Type: string

Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

canarySettings
  • Type: DeploymentCanarySettings structure

The input configuration for the canary deployment when the deployment is a canary release deployment.

description
  • Type: string

The description for the Deployment resource to create.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

stageDescription
  • Type: string

The description of the Stage resource for the Deployment resource to create.

stageName
  • Type: string

The name of the Stage resource for the Deployment resource to create.

tracingEnabled
  • Type: boolean

Specifies whether active tracing with X-ray is enabled for the Stage.

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

A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Result Syntax

[
    'apiSummary' => [
        '<String>' => [
            '<String>' => [
                'apiKeyRequired' => true || false,
                'authorizationType' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
]

Result Details

Members
apiSummary
  • Type: Associative array of custom strings keys (String) to MethodSnapshot structuress

A summary of the RestApi at the date and time that the deployment resource was created.

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

The date and time that the deployment resource was created.

description
  • Type: string

The description for the deployment resource.

id
  • Type: string

The identifier for the deployment resource.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • ServiceUnavailableException:

    The requested service is not available. For details see the accompanying error message. Retry after the specified time period.

CreateDocumentationPart

$result = $client->createDocumentationPart([/* ... */]);
$promise = $client->createDocumentationPartAsync([/* ... */]);

Parameter Syntax

$result = $client->createDocumentationPart([
    'location' => [ // REQUIRED
        'method' => '<string>',
        'name' => '<string>',
        'path' => '<string>',
        'statusCode' => '<string>',
        'type' => 'API|AUTHORIZER|MODEL|RESOURCE|METHOD|PATH_PARAMETER|QUERY_PARAMETER|REQUEST_HEADER|REQUEST_BODY|RESPONSE|RESPONSE_HEADER|RESPONSE_BODY', // REQUIRED
    ],
    'properties' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
location
  • Required: Yes
  • Type: DocumentationPartLocation structure

[Required] The location of the targeted API entity of the to-be-created documentation part.

properties
  • Required: Yes
  • Type: string

[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'id' => '<string>',
    'location' => [
        'method' => '<string>',
        'name' => '<string>',
        'path' => '<string>',
        'statusCode' => '<string>',
        'type' => 'API|AUTHORIZER|MODEL|RESOURCE|METHOD|PATH_PARAMETER|QUERY_PARAMETER|REQUEST_HEADER|REQUEST_BODY|RESPONSE|RESPONSE_HEADER|RESPONSE_BODY',
    ],
    'properties' => '<string>',
]

Result Details

Members
id
  • Type: string

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

location
  • Type: DocumentationPartLocation structure

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

properties
  • Type: string

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

CreateDocumentationVersion

$result = $client->createDocumentationVersion([/* ... */]);
$promise = $client->createDocumentationVersionAsync([/* ... */]);

Parameter Syntax

$result = $client->createDocumentationVersion([
    'description' => '<string>',
    'documentationVersion' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
    'stageName' => '<string>',
]);

Parameter Details

Members
description
  • Type: string

A description about the new documentation snapshot.

documentationVersion
  • Required: Yes
  • Type: string

[Required] The version identifier of the new snapshot.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

stageName
  • Type: string

The stage name to be associated with the new documentation snapshot.

Result Syntax

[
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'version' => '<string>',
]

Result Details

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

The date when the API documentation snapshot is created.

description
  • Type: string

The description of the API documentation snapshot.

version
  • Type: string

The version identifier of the API documentation snapshot.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

CreateDomainName

$result = $client->createDomainName([/* ... */]);
$promise = $client->createDomainNameAsync([/* ... */]);

Creates a new domain name.

Parameter Syntax

$result = $client->createDomainName([
    'certificateArn' => '<string>',
    'certificateBody' => '<string>',
    'certificateChain' => '<string>',
    'certificateName' => '<string>',
    'certificatePrivateKey' => '<string>',
    'domainName' => '<string>', // REQUIRED
    'endpointConfiguration' => [
        'types' => ['<string>', ...],
        'vpcEndpointIds' => ['<string>', ...],
    ],
    'regionalCertificateArn' => '<string>',
    'regionalCertificateName' => '<string>',
    'securityPolicy' => 'TLS_1_0|TLS_1_2',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
certificateArn
  • Type: string

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

certificateBody
  • Type: string

[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

certificateChain
  • Type: string

[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

certificateName
  • Type: string

The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.

certificatePrivateKey
  • Type: string

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

domainName
  • Required: Yes
  • Type: string

[Required] The name of the DomainName resource.

endpointConfiguration
  • Type: EndpointConfiguration structure

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

regionalCertificateArn
  • Type: string

The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.

regionalCertificateName
  • Type: string

The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

securityPolicy
  • Type: string

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Result Syntax

[
    'certificateArn' => '<string>',
    'certificateName' => '<string>',
    'certificateUploadDate' => <DateTime>,
    'distributionDomainName' => '<string>',
    'distributionHostedZoneId' => '<string>',
    'domainName' => '<string>',
    'domainNameStatus' => 'AVAILABLE|UPDATING|PENDING',
    'domainNameStatusMessage' => '<string>',
    'endpointConfiguration' => [
        'types' => ['<string>', ...],
        'vpcEndpointIds' => ['<string>', ...],
    ],
    'regionalCertificateArn' => '<string>',
    'regionalCertificateName' => '<string>',
    'regionalDomainName' => '<string>',
    'regionalHostedZoneId' => '<string>',
    'securityPolicy' => 'TLS_1_0|TLS_1_2',
    'tags' => ['<string>', ...],
]

Result Details

Members
certificateArn
  • Type: string

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

certificateName
  • Type: string

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

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

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

distributionDomainName
  • Type: string

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

distributionHostedZoneId
  • Type: string

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainName
  • Type: string

The custom domain name as an API host name, for example, my-api.example.com.

domainNameStatus
  • Type: string

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

domainNameStatusMessage
  • Type: string

An optional text message containing detailed information about status of the DomainName migration.

endpointConfiguration
  • Type: EndpointConfiguration structure

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

regionalCertificateArn
  • Type: string

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

regionalCertificateName
  • Type: string

The name of the certificate that will be used for validating the regional domain name.

regionalDomainName
  • Type: string

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

regionalHostedZoneId
  • Type: string

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

securityPolicy
  • Type: string

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

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

The collection of tags. Each tag element is associated with a given resource.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

CreateModel

$result = $client->createModel([/* ... */]);
$promise = $client->createModelAsync([/* ... */]);

Adds a new Model resource to an existing RestApi resource.

Parameter Syntax

$result = $client->createModel([
    'contentType' => '<string>', // REQUIRED
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
    'schema' => '<string>',
]);

Parameter Details

Members
contentType
  • Required: Yes
  • Type: string

[Required] The content-type for the model.

description
  • Type: string

The description of the model.

name
  • Required: Yes
  • Type: string

[Required] The name of the model. Must be alphanumeric.

restApiId
  • Required: Yes
  • Type: string

[Required] The RestApi identifier under which the Model will be created.

schema
  • Type: string

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

Result Syntax

[
    'contentType' => '<string>',
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'schema' => '<string>',
]

Result Details

Members
contentType
  • Type: string

The content-type for the model.

description
  • Type: string

The description of the model.

id
  • Type: string

The identifier for the model resource.

name
  • Type: string

The name of the model. Must be an alphanumeric string.

schema
  • Type: string

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

CreateRequestValidator

$result = $client->createRequestValidator([/* ... */]);
$promise = $client->createRequestValidatorAsync([/* ... */]);

Creates a ReqeustValidator of a given RestApi.

Parameter Syntax

$result = $client->createRequestValidator([
    'name' => '<string>',
    'restApiId' => '<string>', // REQUIRED
    'validateRequestBody' => true || false,
    'validateRequestParameters' => true || false,
]);

Parameter Details

Members
name
  • Type: string

The name of the to-be-created RequestValidator.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

validateRequestBody
  • Type: boolean

A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).

validateRequestParameters
  • Type: boolean

A Boolean flag to indicate whether to validate request parameters, true, or not false.

Result Syntax

[
    'id' => '<string>',
    'name' => '<string>',
    'validateRequestBody' => true || false,
    'validateRequestParameters' => true || false,
]

Result Details

Members
id
  • Type: string

The identifier of this RequestValidator.

name
  • Type: string

The name of this RequestValidator

validateRequestBody
  • Type: boolean

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

validateRequestParameters
  • Type: boolean

A Boolean flag to indicate whether to validate request parameters (true) or not (false).

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

CreateResource

$result = $client->createResource([/* ... */]);
$promise = $client->createResourceAsync([/* ... */]);

Creates a Resource resource.

Parameter Syntax

$result = $client->createResource([
    'parentId' => '<string>', // REQUIRED
    'pathPart' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
parentId
  • Required: Yes
  • Type: string

[Required] The parent resource's identifier.

pathPart
  • Required: Yes
  • Type: string

The last path segment for this resource.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'id' => '<string>',
    'parentId' => '<string>',
    'path' => '<string>',
    'pathPart' => '<string>',
    'resourceMethods' => [
        '<String>' => [
            'apiKeyRequired' => true || false,
            'authorizationScopes' => ['<string>', ...],
            'authorizationType' => '<string>',
            'authorizerId' => '<string>',
            'httpMethod' => '<string>',
            'methodIntegration' => [
                'cacheKeyParameters' => ['<string>', ...],
                'cacheNamespace' => '<string>',
                'connectionId' => '<string>',
                'connectionType' => 'INTERNET|VPC_LINK',
                'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
                'credentials' => '<string>',
                'httpMethod' => '<string>',
                'integrationResponses' => [
                    '<String>' => [
                        'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
                        'responseParameters' => ['<string>', ...],
                        'responseTemplates' => ['<string>', ...],
                        'selectionPattern' => '<string>',
                        'statusCode' => '<string>',
                    ],
                    // ...
                ],
                'passthroughBehavior' => '<string>',
                'requestParameters' => ['<string>', ...],
                'requestTemplates' => ['<string>', ...],
                'timeoutInMillis' => <integer>,
                'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY',
                'uri' => '<string>',
            ],
            'methodResponses' => [
                '<String>' => [
                    'responseModels' => ['<string>', ...],
                    'responseParameters' => [true || false, ...],
                    'statusCode' => '<string>',
                ],
                // ...
            ],
            'operationName' => '<string>',
            'requestModels' => ['<string>', ...],
            'requestParameters' => [true || false, ...],
            'requestValidatorId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
id
  • Type: string

The resource's identifier.

parentId
  • Type: string

The parent resource's identifier.

path
  • Type: string

The full path for this resource.

pathPart
  • Type: string

The last path segment for this resource.

resourceMethods
  • Type: Associative array of custom strings keys (String) to Method structures

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }

If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

CreateRestApi

$result = $client->createRestApi([/* ... */]);
$promise = $client->createRestApiAsync([/* ... */]);

Creates a new RestApi resource.

Parameter Syntax

$result = $client->createRestApi([
    'apiKeySource' => 'HEADER|AUTHORIZER',
    'binaryMediaTypes' => ['<string>', ...],
    'cloneFrom' => '<string>',
    'description' => '<string>',
    'endpointConfiguration' => [
        'types' => ['<string>', ...],
        'vpcEndpointIds' => ['<string>', ...],
    ],
    'minimumCompressionSize' => <integer>,
    'name' => '<string>', // REQUIRED
    'policy' => '<string>',
    'tags' => ['<string>', ...],
    'version' => '<string>',
]);

Parameter Details

Members
apiKeySource
  • Type: string

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

binaryMediaTypes
  • Type: Array of strings

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

cloneFrom
  • Type: string

The ID of the RestApi that you want to clone from.

description
  • Type: string

The description of the RestApi.

endpointConfiguration
  • Type: EndpointConfiguration structure

The endpoint configuration of this RestApi showing the endpoint types of the API.

minimumCompressionSize
  • Type: int

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

name
  • Required: Yes
  • Type: string

[Required] The name of the RestApi.

policy
  • Type: string
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
tags
  • Type: Associative array of custom strings keys (String) to strings

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

version
  • Type: string

A version identifier for the API.

Result Syntax

[
    'apiKeySource' => 'HEADER|AUTHORIZER',
    'binaryMediaTypes' => ['<string>', ...],
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'endpointConfiguration' => [
        'types' => ['<string>', ...],
        'vpcEndpointIds' => ['<string>', ...],
    ],
    'id' => '<string>',
    'minimumCompressionSize' => <integer>,
    'name' => '<string>',
    'policy' => '<string>',
    'tags' => ['<string>', ...],
    'version' => '<string>',
    'warnings' => ['<string>', ...],
]

Result Details

Members
apiKeySource
  • Type: string

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

binaryMediaTypes
  • Type: Array of strings

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

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

The timestamp when the API was created.

description
  • Type: string

The API's description.

endpointConfiguration
  • Type: EndpointConfiguration structure

The endpoint configuration of this RestApi showing the endpoint types of the API.

id
  • Type: string

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

minimumCompressionSize
  • Type: int

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

name
  • Type: string

The API's name.

policy
  • Type: string
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
tags
  • Type: Associative array of custom strings keys (String) to strings

The collection of tags. Each tag element is associated with a given resource.

version
  • Type: string

A version identifier for the API.

warnings
  • Type: Array of strings

The warning messages reported when failonwarnings is turned on during API import.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

CreateStage

$result = $client->createStage([/* ... */]);
$promise = $client->createStageAsync([/* ... */]);

Creates a new Stage resource that references a pre-existing Deployment for the API.

Parameter Syntax

$result = $client->createStage([
    'cacheClusterEnabled' => true || false,
    'cacheClusterSize' => '0.5|1.6|6.1|13.5|28.4|58.2|118|237',
    'canarySettings' => [
        'deploymentId' => '<string>',
        'percentTraffic' => <float>,
        'stageVariableOverrides' => ['<string>', ...],
        'useStageCache' => true || false,
    ],
    'deploymentId' => '<string>', // REQUIRED
    'description' => '<string>',
    'documentationVersion' => '<string>',
    'restApiId' => '<string>', // REQUIRED
    'stageName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'tracingEnabled' => true || false,
    'variables' => ['<string>', ...],
]);

Parameter Details

Members
cacheClusterEnabled
  • Type: boolean

Whether cache clustering is enabled for the stage.

cacheClusterSize
  • Type: string

The stage's cache cluster size.

canarySettings
  • Type: CanarySettings structure

The canary deployment settings of this stage.

deploymentId
  • Required: Yes
  • Type: string

[Required] The identifier of the Deployment resource for the Stage resource.

description
  • Type: string

The description of the Stage resource.

documentationVersion
  • Type: string

The version of the associated API documentation.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

stageName
  • Required: Yes
  • Type: string

[Required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

tracingEnabled
  • Type: boolean

Specifies whether active tracing with X-ray is enabled for the Stage.

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

A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Result Syntax

[
    'accessLogSettings' => [
        'destinationArn' => '<string>',
        'format' => '<string>',
    ],
    'cacheClusterEnabled' => true || false,
    'cacheClusterSize' => '0.5|1.6|6.1|13.5|28.4|58.2|118|237',
    'cacheClusterStatus' => 'CREATE_IN_PROGRESS|AVAILABLE|DELETE_IN_PROGRESS|NOT_AVAILABLE|FLUSH_IN_PROGRESS',
    'canarySettings' => [
        'deploymentId' => '<string>',
        'percentTraffic' => <float>,
        'stageVariableOverrides' => ['<string>', ...],
        'useStageCache' => true || false,
    ],
    'clientCertificateId' => '<string>',
    'createdDate' => <DateTime>,
    'deploymentId' => '<string>',
    'description' => '<string>',
    'documentationVersion' => '<string>',
    'lastUpdatedDate' => <DateTime>,
    'methodSettings' => [
        '<String>' => [
            'cacheDataEncrypted' => true || false,
            'cacheTtlInSeconds' => <integer>,
            'cachingEnabled' => true || false,
            'dataTraceEnabled' => true || false,
            'loggingLevel' => '<string>',
            'metricsEnabled' => true || false,
            'requireAuthorizationForCacheControl' => true || false,
            'throttlingBurstLimit' => <integer>,
            'throttlingRateLimit' => <float>,
            'unauthorizedCacheControlHeaderStrategy' => 'FAIL_WITH_403|SUCCEED_WITH_RESPONSE_HEADER|SUCCEED_WITHOUT_RESPONSE_HEADER',
        ],
        // ...
    ],
    'stageName' => '<string>',
    'tags' => ['<string>', ...],
    'tracingEnabled' => true || false,
    'variables' => ['<string>', ...],
    'webAclArn' => '<string>',
]

Result Details

Members
accessLogSettings
  • Type: AccessLogSettings structure

Settings for logging access in this stage.

cacheClusterEnabled
  • Type: boolean

Specifies whether a cache cluster is enabled for the stage.

cacheClusterSize
  • Type: string

The size of the cache cluster for the stage, if enabled.

cacheClusterStatus
  • Type: string

The status of the cache cluster for the stage, if enabled.

canarySettings
  • Type: CanarySettings structure

Settings for the canary deployment in this stage.

clientCertificateId
  • Type: string

The identifier of a client certificate for an API stage.

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

The timestamp when the stage was created.

deploymentId
  • Type: string

The identifier of the Deployment that the stage points to.

description
  • Type: string

The stage's description.

documentationVersion
  • Type: string

The version of the associated API documentation.

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

The timestamp when the stage last updated.

methodSettings
  • Type: Associative array of custom strings keys (String) to MethodSetting structures

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

stageName
  • Type: string

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

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

The collection of tags. Each tag element is associated with a given resource.

tracingEnabled
  • Type: boolean

Specifies whether active tracing with X-ray is enabled for the Stage.

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

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

webAclArn
  • Type: string

The ARN of the WebAcl associated with the Stage.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

CreateUsagePlan

$result = $client->createUsagePlan([/* ... */]);
$promise = $client->createUsagePlanAsync([/* ... */]);

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

Parameter Syntax

$result = $client->createUsagePlan([
    'apiStages' => [
        [
            'apiId' => '<string>',
            'stage' => '<string>',
            'throttle' => [
                '<String>' => [
                    'burstLimit' => <integer>,
                    'rateLimit' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'quota' => [
        'limit' => <integer>,
        'offset' => <integer>,
        'period' => 'DAY|WEEK|MONTH',
    ],
    'tags' => ['<string>', ...],
    'throttle' => [
        'burstLimit' => <integer>,
        'rateLimit' => <float>,
    ],
]);

Parameter Details

Members
apiStages
  • Type: Array of ApiStage structures

The associated API stages of the usage plan.

description
  • Type: string

The description of the usage plan.

name
  • Required: Yes
  • Type: string

[Required] The name of the usage plan.

quota
  • Type: QuotaSettings structure

The quota of the usage plan.

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

throttle
  • Type: ThrottleSettings structure

The throttling limits of the usage plan.

Result Syntax

[
    'apiStages' => [
        [
            'apiId' => '<string>',
            'stage' => '<string>',
            'throttle' => [
                '<String>' => [
                    'burstLimit' => <integer>,
                    'rateLimit' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'productCode' => '<string>',
    'quota' => [
        'limit' => <integer>,
        'offset' => <integer>,
        'period' => 'DAY|WEEK|MONTH',
    ],
    'tags' => ['<string>', ...],
    'throttle' => [
        'burstLimit' => <integer>,
        'rateLimit' => <float>,
    ],
]

Result Details

Members
apiStages
  • Type: Array of ApiStage structures

The associated API stages of a usage plan.

description
  • Type: string

The description of a usage plan.

id
  • Type: string

The identifier of a UsagePlan resource.

name
  • Type: string

The name of a usage plan.

productCode
  • Type: string

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

quota
  • Type: QuotaSettings structure

The maximum number of permitted requests per a given unit time interval.

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

The collection of tags. Each tag element is associated with a given resource.

throttle
  • Type: ThrottleSettings structure

The request throttle limits of a usage plan.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

CreateUsagePlanKey

$result = $client->createUsagePlanKey([/* ... */]);
$promise = $client->createUsagePlanKeyAsync([/* ... */]);

Creates a usage plan key for adding an existing API key to a usage plan.

Parameter Syntax

$result = $client->createUsagePlanKey([
    'keyId' => '<string>', // REQUIRED
    'keyType' => '<string>', // REQUIRED
    'usagePlanId' => '<string>', // REQUIRED
]);

Parameter Details

Members
keyId
  • Required: Yes
  • Type: string

[Required] The identifier of a UsagePlanKey resource for a plan customer.

keyType
  • Required: Yes
  • Type: string

[Required] The type of a UsagePlanKey resource for a plan customer.

usagePlanId
  • Required: Yes
  • Type: string

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

Result Syntax

[
    'id' => '<string>',
    'name' => '<string>',
    'type' => '<string>',
    'value' => '<string>',
]

Result Details

Members
id
  • Type: string

The Id of a usage plan key.

name
  • Type: string

The name of a usage plan key.

type
  • Type: string

The type of a usage plan key. Currently, the valid key type is API_KEY.

value
  • Type: string

The value of a usage plan key.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

CreateVpcLink

$result = $client->createVpcLink([/* ... */]);
$promise = $client->createVpcLinkAsync([/* ... */]);

Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.

Parameter Syntax

$result = $client->createVpcLink([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'targetArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
description
  • Type: string

The description of the VPC link.

name
  • Required: Yes
  • Type: string

[Required] The name used to label and identify the VPC link.

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

targetArns
  • Required: Yes
  • Type: Array of strings

[Required] The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.

Result Syntax

[
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'status' => 'AVAILABLE|PENDING|DELETING|FAILED',
    'statusMessage' => '<string>',
    'tags' => ['<string>', ...],
    'targetArns' => ['<string>', ...],
]

Result Details

Members
description
  • Type: string

The description of the VPC link.

id
  • Type: string

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

name
  • Type: string

The name used to label and identify the VPC link.

status
  • Type: string

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

statusMessage
  • Type: string

A description about the VPC link status.

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

The collection of tags. Each tag element is associated with a given resource.

targetArns
  • Type: Array of strings

The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

DeleteApiKey

$result = $client->deleteApiKey([/* ... */]);
$promise = $client->deleteApiKeyAsync([/* ... */]);

Deletes the ApiKey resource.

Parameter Syntax

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

Parameter Details

Members
apiKey
  • Required: Yes
  • Type: string

[Required] The identifier of the ApiKey resource to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

DeleteAuthorizer

$result = $client->deleteAuthorizer([/* ... */]);
$promise = $client->deleteAuthorizerAsync([/* ... */]);

Deletes an existing Authorizer resource.

AWS CLI

Parameter Syntax

$result = $client->deleteAuthorizer([
    'authorizerId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
authorizerId
  • Required: Yes
  • Type: string

[Required] The identifier of the Authorizer resource.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

DeleteBasePathMapping

$result = $client->deleteBasePathMapping([/* ... */]);
$promise = $client->deleteBasePathMappingAsync([/* ... */]);

Deletes the BasePathMapping resource.

Parameter Syntax

$result = $client->deleteBasePathMapping([
    'basePath' => '<string>', // REQUIRED
    'domainName' => '<string>', // REQUIRED
]);

Parameter Details

Members
basePath
  • Required: Yes
  • Type: string

[Required] The base path name of the BasePathMapping resource to delete.

To specify an empty base path, set this parameter to '(none)'.

domainName
  • Required: Yes
  • Type: string

[Required] The domain name of the BasePathMapping resource to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

DeleteClientCertificate

$result = $client->deleteClientCertificate([/* ... */]);
$promise = $client->deleteClientCertificateAsync([/* ... */]);

Deletes the ClientCertificate resource.

Parameter Syntax

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

Parameter Details

Members
clientCertificateId
  • Required: Yes
  • Type: string

[Required] The identifier of the ClientCertificate resource to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

DeleteDeployment

$result = $client->deleteDeployment([/* ... */]);
$promise = $client->deleteDeploymentAsync([/* ... */]);

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

Parameter Syntax

$result = $client->deleteDeployment([
    'deploymentId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
deploymentId
  • Required: Yes
  • Type: string

[Required] The identifier of the Deployment resource to delete.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

DeleteDocumentationPart

$result = $client->deleteDocumentationPart([/* ... */]);
$promise = $client->deleteDocumentationPartAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteDocumentationPart([
    'documentationPartId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
documentationPartId
  • Required: Yes
  • Type: string

[Required] The identifier of the to-be-deleted documentation part.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

DeleteDocumentationVersion

$result = $client->deleteDocumentationVersion([/* ... */]);
$promise = $client->deleteDocumentationVersionAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteDocumentationVersion([
    'documentationVersion' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
documentationVersion
  • Required: Yes
  • Type: string

[Required] The version identifier of a to-be-deleted documentation snapshot.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

DeleteDomainName

$result = $client->deleteDomainName([/* ... */]);
$promise = $client->deleteDomainNameAsync([/* ... */]);

Deletes the DomainName resource.

Parameter Syntax

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

Parameter Details

Members
domainName
  • Required: Yes
  • Type: string

[Required] The name of the DomainName resource to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

DeleteGatewayResponse

$result = $client->deleteGatewayResponse([/* ... */]);
$promise = $client->deleteGatewayResponseAsync([/* ... */]);

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

Parameter Syntax

$result = $client->deleteGatewayResponse([
    'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
responseType
  • Required: Yes
  • Type: string

[Required]

The response type of the associated GatewayResponse. Valid values are

  • ACCESS_DENIED
  • API_CONFIGURATION_ERROR
  • AUTHORIZER_FAILURE
  • AUTHORIZER_CONFIGURATION_ERROR
  • BAD_REQUEST_PARAMETERS
  • BAD_REQUEST_BODY
  • DEFAULT_4XX
  • DEFAULT_5XX
  • EXPIRED_TOKEN
  • INVALID_SIGNATURE
  • INTEGRATION_FAILURE
  • INTEGRATION_TIMEOUT
  • INVALID_API_KEY
  • MISSING_AUTHENTICATION_TOKEN
  • QUOTA_EXCEEDED
  • REQUEST_TOO_LARGE
  • RESOURCE_NOT_FOUND
  • THROTTLED
  • UNAUTHORIZED
  • UNSUPPORTED_MEDIA_TYPE

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

DeleteIntegration

$result = $client->deleteIntegration([/* ... */]);
$promise = $client->deleteIntegrationAsync([/* ... */]);

Represents a delete integration.

Parameter Syntax

$result = $client->deleteIntegration([
    'httpMethod' => '<string>', // REQUIRED
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
httpMethod
  • Required: Yes
  • Type: string

[Required] Specifies a delete integration request's HTTP method.

resourceId
  • Required: Yes
  • Type: string

[Required] Specifies a delete integration request's resource identifier.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

DeleteIntegrationResponse

$result = $client->deleteIntegrationResponse([/* ... */]);
$promise = $client->deleteIntegrationResponseAsync([/* ... */]);

Represents a delete integration response.

Parameter Syntax

$result = $client->deleteIntegrationResponse([
    'httpMethod' => '<string>', // REQUIRED
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
    'statusCode' => '<string>', // REQUIRED
]);

Parameter Details

Members
httpMethod
  • Required: Yes
  • Type: string

[Required] Specifies a delete integration response request's HTTP method.

resourceId
  • Required: Yes
  • Type: string

[Required] Specifies a delete integration response request's resource identifier.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

statusCode
  • Required: Yes
  • Type: string

[Required] Specifies a delete integration response request's status code.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

DeleteMethod

$result = $client->deleteMethod([/* ... */]);
$promise = $client->deleteMethodAsync([/* ... */]);

Deletes an existing Method resource.

Parameter Syntax

$result = $client->deleteMethod([
    'httpMethod' => '<string>', // REQUIRED
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
httpMethod
  • Required: Yes
  • Type: string

[Required] The HTTP verb of the Method resource.

resourceId
  • Required: Yes
  • Type: string

[Required] The Resource identifier for the Method resource.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

DeleteMethodResponse

$result = $client->deleteMethodResponse([/* ... */]);
$promise = $client->deleteMethodResponseAsync([/* ... */]);

Deletes an existing MethodResponse resource.

Parameter Syntax

$result = $client->deleteMethodResponse([
    'httpMethod' => '<string>', // REQUIRED
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
    'statusCode' => '<string>', // REQUIRED
]);

Parameter Details

Members
httpMethod
  • Required: Yes
  • Type: string

[Required] The HTTP verb of the Method resource.

resourceId
  • Required: Yes
  • Type: string

[Required] The Resource identifier for the MethodResponse resource.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

statusCode
  • Required: Yes
  • Type: string

[Required] The status code identifier for the MethodResponse resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

DeleteModel

$result = $client->deleteModel([/* ... */]);
$promise = $client->deleteModelAsync([/* ... */]);

Deletes a model.

Parameter Syntax

$result = $client->deleteModel([
    'modelName' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
modelName
  • Required: Yes
  • Type: string

[Required] The name of the model to delete.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

DeleteRequestValidator

$result = $client->deleteRequestValidator([/* ... */]);
$promise = $client->deleteRequestValidatorAsync([/* ... */]);

Deletes a RequestValidator of a given RestApi.

Parameter Syntax

$result = $client->deleteRequestValidator([
    'requestValidatorId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
requestValidatorId
  • Required: Yes
  • Type: string

[Required] The identifier of the RequestValidator to be deleted.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

DeleteResource

$result = $client->deleteResource([/* ... */]);
$promise = $client->deleteResourceAsync([/* ... */]);

Deletes a Resource resource.

Parameter Syntax

$result = $client->deleteResource([
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceId
  • Required: Yes
  • Type: string

[Required] The identifier of the Resource resource.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

DeleteRestApi

$result = $client->deleteRestApi([/* ... */]);
$promise = $client->deleteRestApiAsync([/* ... */]);

Deletes the specified API.

Parameter Syntax

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

Parameter Details

Members
restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

DeleteStage

$result = $client->deleteStage([/* ... */]);
$promise = $client->deleteStageAsync([/* ... */]);

Deletes a Stage resource.

Parameter Syntax

$result = $client->deleteStage([
    'restApiId' => '<string>', // REQUIRED
    'stageName' => '<string>', // REQUIRED
]);

Parameter Details

Members
restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

stageName
  • Required: Yes
  • Type: string

[Required] The name of the Stage resource to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

DeleteUsagePlan

$result = $client->deleteUsagePlan([/* ... */]);
$promise = $client->deleteUsagePlanAsync([/* ... */]);

Deletes a usage plan of a given plan Id.

Parameter Syntax

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

Parameter Details

Members
usagePlanId
  • Required: Yes
  • Type: string

[Required] The Id of the to-be-deleted usage plan.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

DeleteUsagePlanKey

$result = $client->deleteUsagePlanKey([/* ... */]);
$promise = $client->deleteUsagePlanKeyAsync([/* ... */]);

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

Parameter Syntax

$result = $client->deleteUsagePlanKey([
    'keyId' => '<string>', // REQUIRED
    'usagePlanId' => '<string>', // REQUIRED
]);

Parameter Details

Members
keyId
  • Required: Yes
  • Type: string

[Required] The Id of the UsagePlanKey resource to be deleted.

usagePlanId
  • Required: Yes
  • Type: string

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

DeleteVpcLink

$result = $client->deleteVpcLink([/* ... */]);
$promise = $client->deleteVpcLinkAsync([/* ... */]);

Deletes an existing VpcLink of a specified identifier.

Parameter Syntax

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

Parameter Details

Members
vpcLinkId
  • Required: Yes
  • Type: string

[Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

FlushStageAuthorizersCache

$result = $client->flushStageAuthorizersCache([/* ... */]);
$promise = $client->flushStageAuthorizersCacheAsync([/* ... */]);

Flushes all authorizer cache entries on a stage.

Parameter Syntax

$result = $client->flushStageAuthorizersCache([
    'restApiId' => '<string>', // REQUIRED
    'stageName' => '<string>', // REQUIRED
]);

Parameter Details

Members
restApiId
  • Required: Yes
  • Type: string

The string identifier of the associated RestApi.

stageName
  • Required: Yes
  • Type: string

The name of the stage to flush.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

FlushStageCache

$result = $client->flushStageCache([/* ... */]);
$promise = $client->flushStageCacheAsync([/* ... */]);

Flushes a stage's cache.

Parameter Syntax

$result = $client->flushStageCache([
    'restApiId' => '<string>', // REQUIRED
    'stageName' => '<string>', // REQUIRED
]);

Parameter Details

Members
restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

stageName
  • Required: Yes
  • Type: string

[Required] The name of the stage to flush its cache.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GenerateClientCertificate

$result = $client->generateClientCertificate([/* ... */]);
$promise = $client->generateClientCertificateAsync([/* ... */]);

Generates a ClientCertificate resource.

Parameter Syntax

$result = $client->generateClientCertificate([
    'description' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
description
  • Type: string

The description of the ClientCertificate.

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Result Syntax

[
    'clientCertificateId' => '<string>',
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'expirationDate' => <DateTime>,
    'pemEncodedCertificate' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members
clientCertificateId
  • Type: string

The identifier of the client certificate.

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

The timestamp when the client certificate was created.

description
  • Type: string

The description of the client certificate.

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

The timestamp when the client certificate will expire.

pemEncodedCertificate
  • Type: string

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

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

The collection of tags. Each tag element is associated with a given resource.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

GetAccount

$result = $client->getAccount([/* ... */]);
$promise = $client->getAccountAsync([/* ... */]);

Gets information about the current Account resource.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'apiKeyVersion' => '<string>',
    'cloudwatchRoleArn' => '<string>',
    'features' => ['<string>', ...],
    'throttleSettings' => [
        'burstLimit' => <integer>,
        'rateLimit' => <float>,
    ],
]

Result Details

Members
apiKeyVersion
  • Type: string

The version of the API keys used for the account.

cloudwatchRoleArn
  • Type: string

The ARN of an Amazon CloudWatch role for the current Account.

features
  • Type: Array of strings

A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".

throttleSettings
  • Type: ThrottleSettings structure

Specifies the API request limits configured for the current Account.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetApiKey

$result = $client->getApiKey([/* ... */]);
$promise = $client->getApiKeyAsync([/* ... */]);

Gets information about the current ApiKey resource.

Parameter Syntax

$result = $client->getApiKey([
    'apiKey' => '<string>', // REQUIRED
    'includeValue' => true || false,
]);

Parameter Details

Members
apiKey
  • Required: Yes
  • Type: string

[Required] The identifier of the ApiKey resource.

includeValue
  • Type: boolean

A boolean flag to specify whether (true) or not (false) the result contains the key value.

Result Syntax

[
    'createdDate' => <DateTime>,
    'customerId' => '<string>',
    'description' => '<string>',
    'enabled' => true || false,
    'id' => '<string>',
    'lastUpdatedDate' => <DateTime>,
    'name' => '<string>',
    'stageKeys' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'value' => '<string>',
]

Result Details

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

The timestamp when the API Key was created.

customerId
  • Type: string

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

description
  • Type: string

The description of the API Key.

enabled
  • Type: boolean

Specifies whether the API Key can be used by callers.

id
  • Type: string

The identifier of the API Key.

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

The timestamp when the API Key was last updated.

name
  • Type: string

The name of the API Key.

stageKeys
  • Type: Array of strings

A list of Stage resources that are associated with the ApiKey resource.

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

The collection of tags. Each tag element is associated with a given resource.

value
  • Type: string

The value of the API Key.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetApiKeys

$result = $client->getApiKeys([/* ... */]);
$promise = $client->getApiKeysAsync([/* ... */]);

Gets information about the current ApiKeys resource.

Parameter Syntax

$result = $client->getApiKeys([
    'customerId' => '<string>',
    'includeValues' => true || false,
    'limit' => <integer>,
    'nameQuery' => '<string>',
    'position' => '<string>',
]);

Parameter Details

Members
customerId
  • Type: string

The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.

includeValues
  • Type: boolean

A boolean flag to specify whether (true) or not (false) the result contains key values.

limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

nameQuery
  • Type: string

The name of queried API keys.

position
  • Type: string

The current pagination position in the paged result set.

Result Syntax

[
    'items' => [
        [
            'createdDate' => <DateTime>,
            'customerId' => '<string>',
            'description' => '<string>',
            'enabled' => true || false,
            'id' => '<string>',
            'lastUpdatedDate' => <DateTime>,
            'name' => '<string>',
            'stageKeys' => ['<string>', ...],
            'tags' => ['<string>', ...],
            'value' => '<string>',
        ],
        // ...
    ],
    'position' => '<string>',
    'warnings' => ['<string>', ...],
]

Result Details

Members
items
  • Type: Array of ApiKey structures

The current page of elements from this collection.

position
  • Type: string
warnings
  • Type: Array of strings

A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetAuthorizer

$result = $client->getAuthorizer([/* ... */]);
$promise = $client->getAuthorizerAsync([/* ... */]);

Describe an existing Authorizer resource.

AWS CLI

Parameter Syntax

$result = $client->getAuthorizer([
    'authorizerId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
authorizerId
  • Required: Yes
  • Type: string

[Required] The identifier of the Authorizer resource.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'authType' => '<string>',
    'authorizerCredentials' => '<string>',
    'authorizerResultTtlInSeconds' => <integer>,
    'authorizerUri' => '<string>',
    'id' => '<string>',
    'identitySource' => '<string>',
    'identityValidationExpression' => '<string>',
    'name' => '<string>',
    'providerARNs' => ['<string>', ...],
    'type' => 'TOKEN|REQUEST|COGNITO_USER_POOLS',
]

Result Details

Members
authType
  • Type: string

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

authorizerCredentials
  • Type: string

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

authorizerResultTtlInSeconds
  • Type: int

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

authorizerUri
  • Type: string

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

id
  • Type: string

The identifier for the authorizer resource.

identitySource
  • Type: string

The identity source for which authorization is requested.

  • For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
  • For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

identityValidationExpression
  • Type: string

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

name
  • Type: string

[Required] The name of the authorizer.

providerARNs
  • Type: Array of strings

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

type
  • Type: string

The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetAuthorizers

$result = $client->getAuthorizers([/* ... */]);
$promise = $client->getAuthorizersAsync([/* ... */]);

Describe an existing Authorizers resource.

AWS CLI

Parameter Syntax

$result = $client->getAuthorizers([
    'limit' => <integer>,
    'position' => '<string>',
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'items' => [
        [
            'authType' => '<string>',
            'authorizerCredentials' => '<string>',
            'authorizerResultTtlInSeconds' => <integer>,
            'authorizerUri' => '<string>',
            'id' => '<string>',
            'identitySource' => '<string>',
            'identityValidationExpression' => '<string>',
            'name' => '<string>',
            'providerARNs' => ['<string>', ...],
            'type' => 'TOKEN|REQUEST|COGNITO_USER_POOLS',
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of Authorizer structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetBasePathMapping

$result = $client->getBasePathMapping([/* ... */]);
$promise = $client->getBasePathMappingAsync([/* ... */]);

Describe a BasePathMapping resource.

Parameter Syntax

$result = $client->getBasePathMapping([
    'basePath' => '<string>', // REQUIRED
    'domainName' => '<string>', // REQUIRED
]);

Parameter Details

Members
basePath
  • Required: Yes
  • Type: string

[Required] The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.

domainName
  • Required: Yes
  • Type: string

[Required] The domain name of the BasePathMapping resource to be described.

Result Syntax

[
    'basePath' => '<string>',
    'restApiId' => '<string>',
    'stage' => '<string>',
]

Result Details

Members
basePath
  • Type: string

The base path name that callers of the API must provide as part of the URL after the domain name.

restApiId
  • Type: string

The string identifier of the associated RestApi.

stage
  • Type: string

The name of the associated stage.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetBasePathMappings

$result = $client->getBasePathMappings([/* ... */]);
$promise = $client->getBasePathMappingsAsync([/* ... */]);

Represents a collection of BasePathMapping resources.

Parameter Syntax

$result = $client->getBasePathMappings([
    'domainName' => '<string>', // REQUIRED
    'limit' => <integer>,
    'position' => '<string>',
]);

Parameter Details

Members
domainName
  • Required: Yes
  • Type: string

[Required] The domain name of a BasePathMapping resource.

limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

Result Syntax

[
    'items' => [
        [
            'basePath' => '<string>',
            'restApiId' => '<string>',
            'stage' => '<string>',
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of BasePathMapping structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetClientCertificate

$result = $client->getClientCertificate([/* ... */]);
$promise = $client->getClientCertificateAsync([/* ... */]);

Gets information about the current ClientCertificate resource.

Parameter Syntax

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

Parameter Details

Members
clientCertificateId
  • Required: Yes
  • Type: string

[Required] The identifier of the ClientCertificate resource to be described.

Result Syntax

[
    'clientCertificateId' => '<string>',
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'expirationDate' => <DateTime>,
    'pemEncodedCertificate' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members
clientCertificateId
  • Type: string

The identifier of the client certificate.

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

The timestamp when the client certificate was created.

description
  • Type: string

The description of the client certificate.

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

The timestamp when the client certificate will expire.

pemEncodedCertificate
  • Type: string

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

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

The collection of tags. Each tag element is associated with a given resource.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetClientCertificates

$result = $client->getClientCertificates([/* ... */]);
$promise = $client->getClientCertificatesAsync([/* ... */]);

Gets a collection of ClientCertificate resources.

Parameter Syntax

$result = $client->getClientCertificates([
    'limit' => <integer>,
    'position' => '<string>',
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

Result Syntax

[
    'items' => [
        [
            'clientCertificateId' => '<string>',
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'expirationDate' => <DateTime>,
            'pemEncodedCertificate' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of ClientCertificate structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetDeployment

$result = $client->getDeployment([/* ... */]);
$promise = $client->getDeploymentAsync([/* ... */]);

Gets information about a Deployment resource.

Parameter Syntax

$result = $client->getDeployment([
    'deploymentId' => '<string>', // REQUIRED
    'embed' => ['<string>', ...],
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
deploymentId
  • Required: Yes
  • Type: string

[Required] The identifier of the Deployment resource to get information about.

embed
  • Type: Array of strings

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'apiSummary' => [
        '<String>' => [
            '<String>' => [
                'apiKeyRequired' => true || false,
                'authorizationType' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
]

Result Details

Members
apiSummary
  • Type: Associative array of custom strings keys (String) to MethodSnapshot structuress

A summary of the RestApi at the date and time that the deployment resource was created.

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

The date and time that the deployment resource was created.

description
  • Type: string

The description for the deployment resource.

id
  • Type: string

The identifier for the deployment resource.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • ServiceUnavailableException:

    The requested service is not available. For details see the accompanying error message. Retry after the specified time period.

GetDeployments

$result = $client->getDeployments([/* ... */]);
$promise = $client->getDeploymentsAsync([/* ... */]);

Gets information about a Deployments collection.

Parameter Syntax

$result = $client->getDeployments([
    'limit' => <integer>,
    'position' => '<string>',
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'items' => [
        [
            'apiSummary' => [
                '<String>' => [
                    '<String>' => [
                        'apiKeyRequired' => true || false,
                        'authorizationType' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of Deployment structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • ServiceUnavailableException:

    The requested service is not available. For details see the accompanying error message. Retry after the specified time period.

GetDocumentationPart

$result = $client->getDocumentationPart([/* ... */]);
$promise = $client->getDocumentationPartAsync([/* ... */]);

Parameter Syntax

$result = $client->getDocumentationPart([
    'documentationPartId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
documentationPartId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'id' => '<string>',
    'location' => [
        'method' => '<string>',
        'name' => '<string>',
        'path' => '<string>',
        'statusCode' => '<string>',
        'type' => 'API|AUTHORIZER|MODEL|RESOURCE|METHOD|PATH_PARAMETER|QUERY_PARAMETER|REQUEST_HEADER|REQUEST_BODY|RESPONSE|RESPONSE_HEADER|RESPONSE_BODY',
    ],
    'properties' => '<string>',
]

Result Details

Members
id
  • Type: string

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

location
  • Type: DocumentationPartLocation structure

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

properties
  • Type: string

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetDocumentationParts

$result = $client->getDocumentationParts([/* ... */]);
$promise = $client->getDocumentationPartsAsync([/* ... */]);

Parameter Syntax

$result = $client->getDocumentationParts([
    'limit' => <integer>,
    'locationStatus' => 'DOCUMENTED|UNDOCUMENTED',
    'nameQuery' => '<string>',
    'path' => '<string>',
    'position' => '<string>',
    'restApiId' => '<string>', // REQUIRED
    'type' => 'API|AUTHORIZER|MODEL|RESOURCE|METHOD|PATH_PARAMETER|QUERY_PARAMETER|REQUEST_HEADER|REQUEST_BODY|RESPONSE|RESPONSE_HEADER|RESPONSE_BODY',
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

locationStatus
  • Type: string

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

nameQuery
  • Type: string

The name of API entities of the to-be-retrieved documentation parts.

path
  • Type: string

The path of API entities of the to-be-retrieved documentation parts.

position
  • Type: string

The current pagination position in the paged result set.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

type
  • Type: string

The type of API entities of the to-be-retrieved documentation parts.

Result Syntax

[
    'items' => [
        [
            'id' => '<string>',
            'location' => [
                'method' => '<string>',
                'name' => '<string>',
                'path' => '<string>',
                'statusCode' => '<string>',
                'type' => 'API|AUTHORIZER|MODEL|RESOURCE|METHOD|PATH_PARAMETER|QUERY_PARAMETER|REQUEST_HEADER|REQUEST_BODY|RESPONSE|RESPONSE_HEADER|RESPONSE_BODY',
            ],
            'properties' => '<string>',
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of DocumentationPart structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetDocumentationVersion

$result = $client->getDocumentationVersion([/* ... */]);
$promise = $client->getDocumentationVersionAsync([/* ... */]);

Parameter Syntax

$result = $client->getDocumentationVersion([
    'documentationVersion' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
documentationVersion
  • Required: Yes
  • Type: string

[Required] The version identifier of the to-be-retrieved documentation snapshot.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'version' => '<string>',
]

Result Details

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

The date when the API documentation snapshot is created.

description
  • Type: string

The description of the API documentation snapshot.

version
  • Type: string

The version identifier of the API documentation snapshot.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetDocumentationVersions

$result = $client->getDocumentationVersions([/* ... */]);
$promise = $client->getDocumentationVersionsAsync([/* ... */]);

Parameter Syntax

$result = $client->getDocumentationVersions([
    'limit' => <integer>,
    'position' => '<string>',
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'items' => [
        [
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of DocumentationVersion structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetDomainName

$result = $client->getDomainName([/* ... */]);
$promise = $client->getDomainNameAsync([/* ... */]);

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

Parameter Syntax

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

Parameter Details

Members
domainName
  • Required: Yes
  • Type: string

[Required] The name of the DomainName resource.

Result Syntax

[
    'certificateArn' => '<string>',
    'certificateName' => '<string>',
    'certificateUploadDate' => <DateTime>,
    'distributionDomainName' => '<string>',
    'distributionHostedZoneId' => '<string>',
    'domainName' => '<string>',
    'domainNameStatus' => 'AVAILABLE|UPDATING|PENDING',
    'domainNameStatusMessage' => '<string>',
    'endpointConfiguration' => [
        'types' => ['<string>', ...],
        'vpcEndpointIds' => ['<string>', ...],
    ],
    'regionalCertificateArn' => '<string>',
    'regionalCertificateName' => '<string>',
    'regionalDomainName' => '<string>',
    'regionalHostedZoneId' => '<string>',
    'securityPolicy' => 'TLS_1_0|TLS_1_2',
    'tags' => ['<string>', ...],
]

Result Details

Members
certificateArn
  • Type: string

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

certificateName
  • Type: string

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

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

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

distributionDomainName
  • Type: string

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

distributionHostedZoneId
  • Type: string

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainName
  • Type: string

The custom domain name as an API host name, for example, my-api.example.com.

domainNameStatus
  • Type: string

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

domainNameStatusMessage
  • Type: string

An optional text message containing detailed information about status of the DomainName migration.

endpointConfiguration
  • Type: EndpointConfiguration structure

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

regionalCertificateArn
  • Type: string

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

regionalCertificateName
  • Type: string

The name of the certificate that will be used for validating the regional domain name.

regionalDomainName
  • Type: string

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

regionalHostedZoneId
  • Type: string

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

securityPolicy
  • Type: string

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

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

The collection of tags. Each tag element is associated with a given resource.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ServiceUnavailableException:

    The requested service is not available. For details see the accompanying error message. Retry after the specified time period.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetDomainNames

$result = $client->getDomainNames([/* ... */]);
$promise = $client->getDomainNamesAsync([/* ... */]);

Represents a collection of DomainName resources.

Parameter Syntax

$result = $client->getDomainNames([
    'limit' => <integer>,
    'position' => '<string>',
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

Result Syntax

[
    'items' => [
        [
            'certificateArn' => '<string>',
            'certificateName' => '<string>',
            'certificateUploadDate' => <DateTime>,
            'distributionDomainName' => '<string>',
            'distributionHostedZoneId' => '<string>',
            'domainName' => '<string>',
            'domainNameStatus' => 'AVAILABLE|UPDATING|PENDING',
            'domainNameStatusMessage' => '<string>',
            'endpointConfiguration' => [
                'types' => ['<string>', ...],
                'vpcEndpointIds' => ['<string>', ...],
            ],
            'regionalCertificateArn' => '<string>',
            'regionalCertificateName' => '<string>',
            'regionalDomainName' => '<string>',
            'regionalHostedZoneId' => '<string>',
            'securityPolicy' => 'TLS_1_0|TLS_1_2',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of DomainName structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetExport

$result = $client->getExport([/* ... */]);
$promise = $client->getExportAsync([/* ... */]);

Exports a deployed version of a RestApi in a specified format.

Parameter Syntax

$result = $client->getExport([
    'accepts' => '<string>',
    'exportType' => '<string>', // REQUIRED
    'parameters' => ['<string>', ...],
    'restApiId' => '<string>', // REQUIRED
    'stageName' => '<string>', // REQUIRED
]);

Parameter Details

Members
accepts
  • Type: string

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

exportType
  • Required: Yes
  • Type: string

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

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

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

stageName
  • Required: Yes
  • Type: string

[Required] The name of the Stage that will be exported.

Result Syntax

[
    'body' => <string || resource || Psr\Http\Message\StreamInterface>,
    'contentDisposition' => '<string>',
    'contentType' => '<string>',
]

Result Details

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

The binary blob response to GetExport, which contains the export.

contentDisposition
  • Type: string

The content-disposition header value in the HTTP response.

contentType
  • Type: string

The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetGatewayResponse

$result = $client->getGatewayResponse([/* ... */]);
$promise = $client->getGatewayResponseAsync([/* ... */]);

Gets a GatewayResponse of a specified response type on the given RestApi.

Parameter Syntax

$result = $client->getGatewayResponse([
    'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
responseType
  • Required: Yes
  • Type: string

[Required]

The response type of the associated GatewayResponse. Valid values are

  • ACCESS_DENIED
  • API_CONFIGURATION_ERROR
  • AUTHORIZER_FAILURE
  • AUTHORIZER_CONFIGURATION_ERROR
  • BAD_REQUEST_PARAMETERS
  • BAD_REQUEST_BODY
  • DEFAULT_4XX
  • DEFAULT_5XX
  • EXPIRED_TOKEN
  • INVALID_SIGNATURE
  • INTEGRATION_FAILURE
  • INTEGRATION_TIMEOUT
  • INVALID_API_KEY
  • MISSING_AUTHENTICATION_TOKEN
  • QUOTA_EXCEEDED
  • REQUEST_TOO_LARGE
  • RESOURCE_NOT_FOUND
  • THROTTLED
  • UNAUTHORIZED
  • UNSUPPORTED_MEDIA_TYPE

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'defaultResponse' => true || false,
    'responseParameters' => ['<string>', ...],
    'responseTemplates' => ['<string>', ...],
    'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED',
    'statusCode' => '<string>',
]

Result Details

Members
defaultResponse
  • Type: boolean

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

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

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

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

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

responseType
  • Type: string

The response type of the associated GatewayResponse. Valid values are

  • ACCESS_DENIED
  • API_CONFIGURATION_ERROR
  • AUTHORIZER_FAILURE
  • AUTHORIZER_CONFIGURATION_ERROR
  • BAD_REQUEST_PARAMETERS
  • BAD_REQUEST_BODY
  • DEFAULT_4XX
  • DEFAULT_5XX
  • EXPIRED_TOKEN
  • INVALID_SIGNATURE
  • INTEGRATION_FAILURE
  • INTEGRATION_TIMEOUT
  • INVALID_API_KEY
  • MISSING_AUTHENTICATION_TOKEN
  • QUOTA_EXCEEDED
  • REQUEST_TOO_LARGE
  • RESOURCE_NOT_FOUND
  • THROTTLED
  • UNAUTHORIZED
  • UNSUPPORTED_MEDIA_TYPE

statusCode
  • Type: string

The HTTP status code for this GatewayResponse.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetGatewayResponses

$result = $client->getGatewayResponses([/* ... */]);
$promise = $client->getGatewayResponsesAsync([/* ... */]);

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.

Parameter Syntax

$result = $client->getGatewayResponses([
    'limit' => <integer>,
    'position' => '<string>',
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.

position
  • Type: string

The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'items' => [
        [
            'defaultResponse' => true || false,
            'responseParameters' => ['<string>', ...],
            'responseTemplates' => ['<string>', ...],
            'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED',
            'statusCode' => '<string>',
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of GatewayResponse structures

Returns the entire collection, because of no pagination support.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetIntegration

$result = $client->getIntegration([/* ... */]);
$promise = $client->getIntegrationAsync([/* ... */]);

Get the integration settings.

Parameter Syntax

$result = $client->getIntegration([
    'httpMethod' => '<string>', // REQUIRED
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
httpMethod
  • Required: Yes
  • Type: string

[Required] Specifies a get integration request's HTTP method.

resourceId
  • Required: Yes
  • Type: string

[Required] Specifies a get integration request's resource identifier

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'cacheKeyParameters' => ['<string>', ...],
    'cacheNamespace' => '<string>',
    'connectionId' => '<string>',
    'connectionType' => 'INTERNET|VPC_LINK',
    'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'credentials' => '<string>',
    'httpMethod' => '<string>',
    'integrationResponses' => [
        '<String>' => [
            'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
            'responseParameters' => ['<string>', ...],
            'responseTemplates' => ['<string>', ...],
            'selectionPattern' => '<string>',
            'statusCode' => '<string>',
        ],
        // ...
    ],
    'passthroughBehavior' => '<string>',
    'requestParameters' => ['<string>', ...],
    'requestTemplates' => ['<string>', ...],
    'timeoutInMillis' => <integer>,
    'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY',
    'uri' => '<string>',
]

Result Details

Members
cacheKeyParameters
  • Type: Array of strings

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

cacheNamespace
  • Type: string

An API-specific tag group of related cached parameters. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

connectionId
  • Type: string

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

connectionType
  • Type: string

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

contentHandling
  • Type: string

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

credentials
  • Type: string

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.

httpMethod
  • Type: string

Specifies the integration's HTTP method type.

integrationResponses
  • Type: Associative array of custom strings keys (String) to IntegrationResponse structures

Specifies the integration's responses.

Example: Get integration responses of a method

Request

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response

The successful response returns 200 OK status and a payload as follows:

{ "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }

Creating an API
passthroughBehavior
  • Type: string

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:

  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
requestParameters
  • Type: Associative array of custom strings keys (String) to strings

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

timeoutInMillis
  • Type: int

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

type
  • Type: string

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

uri
  • Type: string

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetIntegrationResponse

$result = $client->getIntegrationResponse([/* ... */]);
$promise = $client->getIntegrationResponseAsync([/* ... */]);

Represents a get integration response.

Parameter Syntax

$result = $client->getIntegrationResponse([
    'httpMethod' => '<string>', // REQUIRED
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
    'statusCode' => '<string>', // REQUIRED
]);

Parameter Details

Members
httpMethod
  • Required: Yes
  • Type: string

[Required] Specifies a get integration response request's HTTP method.

resourceId
  • Required: Yes
  • Type: string

[Required] Specifies a get integration response request's resource identifier.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

statusCode
  • Required: Yes
  • Type: string

[Required] Specifies a get integration response request's status code.

Result Syntax

[
    'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'responseParameters' => ['<string>', ...],
    'responseTemplates' => ['<string>', ...],
    'selectionPattern' => '<string>',
    'statusCode' => '<string>',
]

Result Details

Members
contentHandling
  • Type: string

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

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

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

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

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

selectionPattern
  • Type: string

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

statusCode
  • Type: string

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetMethod

$result = $client->getMethod([/* ... */]);
$promise = $client->getMethodAsync([/* ... */]);

Describe an existing Method resource.

Parameter Syntax

$result = $client->getMethod([
    'httpMethod' => '<string>', // REQUIRED
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
httpMethod
  • Required: Yes
  • Type: string

[Required] Specifies the method request's HTTP method type.

resourceId
  • Required: Yes
  • Type: string

[Required] The Resource identifier for the Method resource.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'apiKeyRequired' => true || false,
    'authorizationScopes' => ['<string>', ...],
    'authorizationType' => '<string>',
    'authorizerId' => '<string>',
    'httpMethod' => '<string>',
    'methodIntegration' => [
        'cacheKeyParameters' => ['<string>', ...],
        'cacheNamespace' => '<string>',
        'connectionId' => '<string>',
        'connectionType' => 'INTERNET|VPC_LINK',
        'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
        'credentials' => '<string>',
        'httpMethod' => '<string>',
        'integrationResponses' => [
            '<String>' => [
                'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
                'responseParameters' => ['<string>', ...],
                'responseTemplates' => ['<string>', ...],
                'selectionPattern' => '<string>',
                'statusCode' => '<string>',
            ],
            // ...
        ],
        'passthroughBehavior' => '<string>',
        'requestParameters' => ['<string>', ...],
        'requestTemplates' => ['<string>', ...],
        'timeoutInMillis' => <integer>,
        'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY',
        'uri' => '<string>',
    ],
    'methodResponses' => [
        '<String>' => [
            'responseModels' => ['<string>', ...],
            'responseParameters' => [true || false, ...],
            'statusCode' => '<string>',
        ],
        // ...
    ],
    'operationName' => '<string>',
    'requestModels' => ['<string>', ...],
    'requestParameters' => [true || false, ...],
    'requestValidatorId' => '<string>',
]

Result Details

Members
apiKeyRequired
  • Type: boolean

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

authorizationScopes
  • Type: Array of strings

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

authorizationType
  • Type: string

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

authorizerId
  • Type: string

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

httpMethod
  • Type: string

The method's HTTP verb.

methodIntegration
  • Type: Integration structure

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } }

AWS CLI
methodResponses
  • Type: Associative array of custom strings keys (String) to MethodResponse structures

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }

AWS CLI
operationName
  • Type: string

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

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

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

requestValidatorId
  • Type: string

The identifier of a RequestValidator for request validation.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetMethodResponse

$result = $client->getMethodResponse([/* ... */]);
$promise = $client->getMethodResponseAsync([/* ... */]);

Describes a MethodResponse resource.

Parameter Syntax

$result = $client->getMethodResponse([
    'httpMethod' => '<string>', // REQUIRED
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
    'statusCode' => '<string>', // REQUIRED
]);

Parameter Details

Members
httpMethod
  • Required: Yes
  • Type: string

[Required] The HTTP verb of the Method resource.

resourceId
  • Required: Yes
  • Type: string

[Required] The Resource identifier for the MethodResponse resource.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

statusCode
  • Required: Yes
  • Type: string

[Required] The status code for the MethodResponse resource.

Result Syntax

[
    'responseModels' => ['<string>', ...],
    'responseParameters' => [true || false, ...],
    'statusCode' => '<string>',
]

Result Details

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

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

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

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

statusCode
  • Type: string

The method response's status code.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetModel

$result = $client->getModel([/* ... */]);
$promise = $client->getModelAsync([/* ... */]);

Describes an existing model defined for a RestApi resource.

Parameter Syntax

$result = $client->getModel([
    'flatten' => true || false,
    'modelName' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
flatten
  • Type: boolean

A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.

modelName
  • Required: Yes
  • Type: string

[Required] The name of the model as an identifier.

restApiId
  • Required: Yes
  • Type: string

[Required] The RestApi identifier under which the Model exists.

Result Syntax

[
    'contentType' => '<string>',
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'schema' => '<string>',
]

Result Details

Members
contentType
  • Type: string

The content-type for the model.

description
  • Type: string

The description of the model.

id
  • Type: string

The identifier for the model resource.

name
  • Type: string

The name of the model. Must be an alphanumeric string.

schema
  • Type: string

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetModelTemplate

$result = $client->getModelTemplate([/* ... */]);
$promise = $client->getModelTemplateAsync([/* ... */]);

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

Parameter Syntax

$result = $client->getModelTemplate([
    'modelName' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
modelName
  • Required: Yes
  • Type: string

[Required] The name of the model for which to generate a template.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

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

Result Details

Members
value
  • Type: string

The Apache Velocity Template Language (VTL) template content used for the template resource.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetModels

$result = $client->getModels([/* ... */]);
$promise = $client->getModelsAsync([/* ... */]);

Describes existing Models defined for a RestApi resource.

Parameter Syntax

$result = $client->getModels([
    'limit' => <integer>,
    'position' => '<string>',
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'items' => [
        [
            'contentType' => '<string>',
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'schema' => '<string>',
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of Model structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetRequestValidator

$result = $client->getRequestValidator([/* ... */]);
$promise = $client->getRequestValidatorAsync([/* ... */]);

Gets a RequestValidator of a given RestApi.

Parameter Syntax

$result = $client->getRequestValidator([
    'requestValidatorId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
requestValidatorId
  • Required: Yes
  • Type: string

[Required] The identifier of the RequestValidator to be retrieved.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'id' => '<string>',
    'name' => '<string>',
    'validateRequestBody' => true || false,
    'validateRequestParameters' => true || false,
]

Result Details

Members
id
  • Type: string

The identifier of this RequestValidator.

name
  • Type: string

The name of this RequestValidator

validateRequestBody
  • Type: boolean

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

validateRequestParameters
  • Type: boolean

A Boolean flag to indicate whether to validate request parameters (true) or not (false).

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetRequestValidators

$result = $client->getRequestValidators([/* ... */]);
$promise = $client->getRequestValidatorsAsync([/* ... */]);

Gets the RequestValidators collection of a given RestApi.

Parameter Syntax

$result = $client->getRequestValidators([
    'limit' => <integer>,
    'position' => '<string>',
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'items' => [
        [
            'id' => '<string>',
            'name' => '<string>',
            'validateRequestBody' => true || false,
            'validateRequestParameters' => true || false,
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of RequestValidator structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetResource

$result = $client->getResource([/* ... */]);
$promise = $client->getResourceAsync([/* ... */]);

Lists information about a resource.

Parameter Syntax

$result = $client->getResource([
    'embed' => ['<string>', ...],
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
embed
  • Type: Array of strings

A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods.

resourceId
  • Required: Yes
  • Type: string

[Required] The identifier for the Resource resource.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'id' => '<string>',
    'parentId' => '<string>',
    'path' => '<string>',
    'pathPart' => '<string>',
    'resourceMethods' => [
        '<String>' => [
            'apiKeyRequired' => true || false,
            'authorizationScopes' => ['<string>', ...],
            'authorizationType' => '<string>',
            'authorizerId' => '<string>',
            'httpMethod' => '<string>',
            'methodIntegration' => [
                'cacheKeyParameters' => ['<string>', ...],
                'cacheNamespace' => '<string>',
                'connectionId' => '<string>',
                'connectionType' => 'INTERNET|VPC_LINK',
                'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
                'credentials' => '<string>',
                'httpMethod' => '<string>',
                'integrationResponses' => [
                    '<String>' => [
                        'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
                        'responseParameters' => ['<string>', ...],
                        'responseTemplates' => ['<string>', ...],
                        'selectionPattern' => '<string>',
                        'statusCode' => '<string>',
                    ],
                    // ...
                ],
                'passthroughBehavior' => '<string>',
                'requestParameters' => ['<string>', ...],
                'requestTemplates' => ['<string>', ...],
                'timeoutInMillis' => <integer>,
                'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY',
                'uri' => '<string>',
            ],
            'methodResponses' => [
                '<String>' => [
                    'responseModels' => ['<string>', ...],
                    'responseParameters' => [true || false, ...],
                    'statusCode' => '<string>',
                ],
                // ...
            ],
            'operationName' => '<string>',
            'requestModels' => ['<string>', ...],
            'requestParameters' => [true || false, ...],
            'requestValidatorId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
id
  • Type: string

The resource's identifier.

parentId
  • Type: string

The parent resource's identifier.

path
  • Type: string

The full path for this resource.

pathPart
  • Type: string

The last path segment for this resource.

resourceMethods
  • Type: Associative array of custom strings keys (String) to Method structures

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }

If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetResources

$result = $client->getResources([/* ... */]);
$promise = $client->getResourcesAsync([/* ... */]);

Lists information about a collection of Resource resources.

Parameter Syntax

$result = $client->getResources([
    'embed' => ['<string>', ...],
    'limit' => <integer>,
    'position' => '<string>',
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
embed
  • Type: Array of strings

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'items' => [
        [
            'id' => '<string>',
            'parentId' => '<string>',
            'path' => '<string>',
            'pathPart' => '<string>',
            'resourceMethods' => [
                '<String>' => [
                    'apiKeyRequired' => true || false,
                    'authorizationScopes' => ['<string>', ...],
                    'authorizationType' => '<string>',
                    'authorizerId' => '<string>',
                    'httpMethod' => '<string>',
                    'methodIntegration' => [
                        'cacheKeyParameters' => ['<string>', ...],
                        'cacheNamespace' => '<string>',
                        'connectionId' => '<string>',
                        'connectionType' => 'INTERNET|VPC_LINK',
                        'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
                        'credentials' => '<string>',
                        'httpMethod' => '<string>',
                        'integrationResponses' => [
                            '<String>' => [
                                'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
                                'responseParameters' => ['<string>', ...],
                                'responseTemplates' => ['<string>', ...],
                                'selectionPattern' => '<string>',
                                'statusCode' => '<string>',
                            ],
                            // ...
                        ],
                        'passthroughBehavior' => '<string>',
                        'requestParameters' => ['<string>', ...],
                        'requestTemplates' => ['<string>', ...],
                        'timeoutInMillis' => <integer>,
                        'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY',
                        'uri' => '<string>',
                    ],
                    'methodResponses' => [
                        '<String>' => [
                            'responseModels' => ['<string>', ...],
                            'responseParameters' => [true || false, ...],
                            'statusCode' => '<string>',
                        ],
                        // ...
                    ],
                    'operationName' => '<string>',
                    'requestModels' => ['<string>', ...],
                    'requestParameters' => [true || false, ...],
                    'requestValidatorId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of Resource structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetRestApi

$result = $client->getRestApi([/* ... */]);
$promise = $client->getRestApiAsync([/* ... */]);

Lists the RestApi resource in the collection.

Parameter Syntax

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

Parameter Details

Members
restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'apiKeySource' => 'HEADER|AUTHORIZER',
    'binaryMediaTypes' => ['<string>', ...],
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'endpointConfiguration' => [
        'types' => ['<string>', ...],
        'vpcEndpointIds' => ['<string>', ...],
    ],
    'id' => '<string>',
    'minimumCompressionSize' => <integer>,
    'name' => '<string>',
    'policy' => '<string>',
    'tags' => ['<string>', ...],
    'version' => '<string>',
    'warnings' => ['<string>', ...],
]

Result Details

Members
apiKeySource
  • Type: string

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

binaryMediaTypes
  • Type: Array of strings

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

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

The timestamp when the API was created.

description
  • Type: string

The API's description.

endpointConfiguration
  • Type: EndpointConfiguration structure

The endpoint configuration of this RestApi showing the endpoint types of the API.

id
  • Type: string

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

minimumCompressionSize
  • Type: int

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

name
  • Type: string

The API's name.

policy
  • Type: string
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
tags
  • Type: Associative array of custom strings keys (String) to strings

The collection of tags. Each tag element is associated with a given resource.

version
  • Type: string

A version identifier for the API.

warnings
  • Type: Array of strings

The warning messages reported when failonwarnings is turned on during API import.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetRestApis

$result = $client->getRestApis([/* ... */]);
$promise = $client->getRestApisAsync([/* ... */]);

Lists the RestApis resources for your collection.

Parameter Syntax

$result = $client->getRestApis([
    'limit' => <integer>,
    'position' => '<string>',
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

Result Syntax

[
    'items' => [
        [
            'apiKeySource' => 'HEADER|AUTHORIZER',
            'binaryMediaTypes' => ['<string>', ...],
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'endpointConfiguration' => [
                'types' => ['<string>', ...],
                'vpcEndpointIds' => ['<string>', ...],
            ],
            'id' => '<string>',
            'minimumCompressionSize' => <integer>,
            'name' => '<string>',
            'policy' => '<string>',
            'tags' => ['<string>', ...],
            'version' => '<string>',
            'warnings' => ['<string>', ...],
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of RestApi structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetSdk

$result = $client->getSdk([/* ... */]);
$promise = $client->getSdkAsync([/* ... */]);

Generates a client SDK for a RestApi and Stage.

Parameter Syntax

$result = $client->getSdk([
    'parameters' => ['<string>', ...],
    'restApiId' => '<string>', // REQUIRED
    'sdkType' => '<string>', // REQUIRED
    'stageName' => '<string>', // REQUIRED
]);

Parameter Details

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

A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

sdkType
  • Required: Yes
  • Type: string

[Required] The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.

stageName
  • Required: Yes
  • Type: string

[Required] The name of the Stage that the SDK will use.

Result Syntax

[
    'body' => <string || resource || Psr\Http\Message\StreamInterface>,
    'contentDisposition' => '<string>',
    'contentType' => '<string>',
]

Result Details

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

The binary blob response to GetSdk, which contains the generated SDK.

contentDisposition
  • Type: string

The content-disposition header value in the HTTP response.

contentType
  • Type: string

The content-type header value in the HTTP response.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetSdkType

$result = $client->getSdkType([/* ... */]);
$promise = $client->getSdkTypeAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Members
id
  • Required: Yes
  • Type: string

[Required] The identifier of the queried SdkType instance.

Result Syntax

[
    'configurationProperties' => [
        [
            'defaultValue' => '<string>',
            'description' => '<string>',
            'friendlyName' => '<string>',
            'name' => '<string>',
            'required' => true || false,
        ],
        // ...
    ],
    'description' => '<string>',
    'friendlyName' => '<string>',
    'id' => '<string>',
]

Result Details

Members
configurationProperties
  • Type: Array of SdkConfigurationProperty structures

A list of configuration properties of an SdkType.

description
  • Type: string

The description of an SdkType.

friendlyName
  • Type: string

The user-friendly name of an SdkType instance.

id
  • Type: string

The identifier of an SdkType instance.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetSdkTypes

$result = $client->getSdkTypes([/* ... */]);
$promise = $client->getSdkTypesAsync([/* ... */]);

Parameter Syntax

$result = $client->getSdkTypes([
    'limit' => <integer>,
    'position' => '<string>',
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

Result Syntax

[
    'items' => [
        [
            'configurationProperties' => [
                [
                    'defaultValue' => '<string>',
                    'description' => '<string>',
                    'friendlyName' => '<string>',
                    'name' => '<string>',
                    'required' => true || false,
                ],
                // ...
            ],
            'description' => '<string>',
            'friendlyName' => '<string>',
            'id' => '<string>',
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of SdkType structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetStage

$result = $client->getStage([/* ... */]);
$promise = $client->getStageAsync([/* ... */]);

Gets information about a Stage resource.

Parameter Syntax

$result = $client->getStage([
    'restApiId' => '<string>', // REQUIRED
    'stageName' => '<string>', // REQUIRED
]);

Parameter Details

Members
restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

stageName
  • Required: Yes
  • Type: string

[Required] The name of the Stage resource to get information about.

Result Syntax

[
    'accessLogSettings' => [
        'destinationArn' => '<string>',
        'format' => '<string>',
    ],
    'cacheClusterEnabled' => true || false,
    'cacheClusterSize' => '0.5|1.6|6.1|13.5|28.4|58.2|118|237',
    'cacheClusterStatus' => 'CREATE_IN_PROGRESS|AVAILABLE|DELETE_IN_PROGRESS|NOT_AVAILABLE|FLUSH_IN_PROGRESS',
    'canarySettings' => [
        'deploymentId' => '<string>',
        'percentTraffic' => <float>,
        'stageVariableOverrides' => ['<string>', ...],
        'useStageCache' => true || false,
    ],
    'clientCertificateId' => '<string>',
    'createdDate' => <DateTime>,
    'deploymentId' => '<string>',
    'description' => '<string>',
    'documentationVersion' => '<string>',
    'lastUpdatedDate' => <DateTime>,
    'methodSettings' => [
        '<String>' => [
            'cacheDataEncrypted' => true || false,
            'cacheTtlInSeconds' => <integer>,
            'cachingEnabled' => true || false,
            'dataTraceEnabled' => true || false,
            'loggingLevel' => '<string>',
            'metricsEnabled' => true || false,
            'requireAuthorizationForCacheControl' => true || false,
            'throttlingBurstLimit' => <integer>,
            'throttlingRateLimit' => <float>,
            'unauthorizedCacheControlHeaderStrategy' => 'FAIL_WITH_403|SUCCEED_WITH_RESPONSE_HEADER|SUCCEED_WITHOUT_RESPONSE_HEADER',
        ],
        // ...
    ],
    'stageName' => '<string>',
    'tags' => ['<string>', ...],
    'tracingEnabled' => true || false,
    'variables' => ['<string>', ...],
    'webAclArn' => '<string>',
]

Result Details

Members
accessLogSettings
  • Type: AccessLogSettings structure

Settings for logging access in this stage.

cacheClusterEnabled
  • Type: boolean

Specifies whether a cache cluster is enabled for the stage.

cacheClusterSize
  • Type: string

The size of the cache cluster for the stage, if enabled.

cacheClusterStatus
  • Type: string

The status of the cache cluster for the stage, if enabled.

canarySettings
  • Type: CanarySettings structure

Settings for the canary deployment in this stage.

clientCertificateId
  • Type: string

The identifier of a client certificate for an API stage.

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

The timestamp when the stage was created.

deploymentId
  • Type: string

The identifier of the Deployment that the stage points to.

description
  • Type: string

The stage's description.

documentationVersion
  • Type: string

The version of the associated API documentation.

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

The timestamp when the stage last updated.

methodSettings
  • Type: Associative array of custom strings keys (String) to MethodSetting structures

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

stageName
  • Type: string

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

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

The collection of tags. Each tag element is associated with a given resource.

tracingEnabled
  • Type: boolean

Specifies whether active tracing with X-ray is enabled for the Stage.

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

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

webAclArn
  • Type: string

The ARN of the WebAcl associated with the Stage.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetStages

$result = $client->getStages([/* ... */]);
$promise = $client->getStagesAsync([/* ... */]);

Gets information about one or more Stage resources.

Parameter Syntax

$result = $client->getStages([
    'deploymentId' => '<string>',
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
deploymentId
  • Type: string

The stages' deployment identifiers.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'item' => [
        [
            'accessLogSettings' => [
                'destinationArn' => '<string>',
                'format' => '<string>',
            ],
            'cacheClusterEnabled' => true || false,
            'cacheClusterSize' => '0.5|1.6|6.1|13.5|28.4|58.2|118|237',
            'cacheClusterStatus' => 'CREATE_IN_PROGRESS|AVAILABLE|DELETE_IN_PROGRESS|NOT_AVAILABLE|FLUSH_IN_PROGRESS',
            'canarySettings' => [
                'deploymentId' => '<string>',
                'percentTraffic' => <float>,
                'stageVariableOverrides' => ['<string>', ...],
                'useStageCache' => true || false,
            ],
            'clientCertificateId' => '<string>',
            'createdDate' => <DateTime>,
            'deploymentId' => '<string>',
            'description' => '<string>',
            'documentationVersion' => '<string>',
            'lastUpdatedDate' => <DateTime>,
            'methodSettings' => [
                '<String>' => [
                    'cacheDataEncrypted' => true || false,
                    'cacheTtlInSeconds' => <integer>,
                    'cachingEnabled' => true || false,
                    'dataTraceEnabled' => true || false,
                    'loggingLevel' => '<string>',
                    'metricsEnabled' => true || false,
                    'requireAuthorizationForCacheControl' => true || false,
                    'throttlingBurstLimit' => <integer>,
                    'throttlingRateLimit' => <float>,
                    'unauthorizedCacheControlHeaderStrategy' => 'FAIL_WITH_403|SUCCEED_WITH_RESPONSE_HEADER|SUCCEED_WITHOUT_RESPONSE_HEADER',
                ],
                // ...
            ],
            'stageName' => '<string>',
            'tags' => ['<string>', ...],
            'tracingEnabled' => true || false,
            'variables' => ['<string>', ...],
            'webAclArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
item
  • Type: Array of Stage structures

The current page of elements from this collection.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetTags

$result = $client->getTags([/* ... */]);
$promise = $client->getTagsAsync([/* ... */]);

Gets the Tags collection for a given resource.

Parameter Syntax

$result = $client->getTags([
    'limit' => <integer>,
    'position' => '<string>',
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
limit
  • Type: int

(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

(Not currently supported) The current pagination position in the paged result set.

resourceArn
  • Required: Yes
  • Type: string

[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.

Result Syntax

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

Result Details

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

The collection of tags. Each tag element is associated with a given resource.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

GetUsage

$result = $client->getUsage([/* ... */]);
$promise = $client->getUsageAsync([/* ... */]);

Gets the usage data of a usage plan in a specified time interval.

Parameter Syntax

$result = $client->getUsage([
    'endDate' => '<string>', // REQUIRED
    'keyId' => '<string>',
    'limit' => <integer>,
    'position' => '<string>',
    'startDate' => '<string>', // REQUIRED
    'usagePlanId' => '<string>', // REQUIRED
]);

Parameter Details

Members
endDate
  • Required: Yes
  • Type: string

[Required] The ending date (e.g., 2016-12-31) of the usage data.

keyId
  • Type: string

The Id of the API key associated with the resultant usage data.

limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

startDate
  • Required: Yes
  • Type: string

[Required] The starting date (e.g., 2016-01-01) of the usage data.

usagePlanId
  • Required: Yes
  • Type: string

[Required] The Id of the usage plan associated with the usage data.

Result Syntax

[
    'endDate' => '<string>',
    'items' => [
        '<String>' => [
            [<integer>, ...],
            // ...
        ],
        // ...
    ],
    'position' => '<string>',
    'startDate' => '<string>',
    'usagePlanId' => '<string>',
]

Result Details

Members
endDate
  • Type: string

The ending date of the usage data.

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

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

position
  • Type: string
startDate
  • Type: string

The starting date of the usage data.

usagePlanId
  • Type: string

The plan Id associated with this usage data.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetUsagePlan

$result = $client->getUsagePlan([/* ... */]);
$promise = $client->getUsagePlanAsync([/* ... */]);

Gets a usage plan of a given plan identifier.

Parameter Syntax

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

Parameter Details

Members
usagePlanId
  • Required: Yes
  • Type: string

[Required] The identifier of the UsagePlan resource to be retrieved.

Result Syntax

[
    'apiStages' => [
        [
            'apiId' => '<string>',
            'stage' => '<string>',
            'throttle' => [
                '<String>' => [
                    'burstLimit' => <integer>,
                    'rateLimit' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'productCode' => '<string>',
    'quota' => [
        'limit' => <integer>,
        'offset' => <integer>,
        'period' => 'DAY|WEEK|MONTH',
    ],
    'tags' => ['<string>', ...],
    'throttle' => [
        'burstLimit' => <integer>,
        'rateLimit' => <float>,
    ],
]

Result Details

Members
apiStages
  • Type: Array of ApiStage structures

The associated API stages of a usage plan.

description
  • Type: string

The description of a usage plan.

id
  • Type: string

The identifier of a UsagePlan resource.

name
  • Type: string

The name of a usage plan.

productCode
  • Type: string

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

quota
  • Type: QuotaSettings structure

The maximum number of permitted requests per a given unit time interval.

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

The collection of tags. Each tag element is associated with a given resource.

throttle
  • Type: ThrottleSettings structure

The request throttle limits of a usage plan.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetUsagePlanKey

$result = $client->getUsagePlanKey([/* ... */]);
$promise = $client->getUsagePlanKeyAsync([/* ... */]);

Gets a usage plan key of a given key identifier.

Parameter Syntax

$result = $client->getUsagePlanKey([
    'keyId' => '<string>', // REQUIRED
    'usagePlanId' => '<string>', // REQUIRED
]);

Parameter Details

Members
keyId
  • Required: Yes
  • Type: string

[Required] The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

usagePlanId
  • Required: Yes
  • Type: string

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Result Syntax

[
    'id' => '<string>',
    'name' => '<string>',
    'type' => '<string>',
    'value' => '<string>',
]

Result Details

Members
id
  • Type: string

The Id of a usage plan key.

name
  • Type: string

The name of a usage plan key.

type
  • Type: string

The type of a usage plan key. Currently, the valid key type is API_KEY.

value
  • Type: string

The value of a usage plan key.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetUsagePlanKeys

$result = $client->getUsagePlanKeys([/* ... */]);
$promise = $client->getUsagePlanKeysAsync([/* ... */]);

Gets all the usage plan keys representing the API keys added to a specified usage plan.

Parameter Syntax

$result = $client->getUsagePlanKeys([
    'limit' => <integer>,
    'nameQuery' => '<string>',
    'position' => '<string>',
    'usagePlanId' => '<string>', // REQUIRED
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

nameQuery
  • Type: string

A query parameter specifying the name of the to-be-returned usage plan keys.

position
  • Type: string

The current pagination position in the paged result set.

usagePlanId
  • Required: Yes
  • Type: string

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Result Syntax

[
    'items' => [
        [
            'id' => '<string>',
            'name' => '<string>',
            'type' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of UsagePlanKey structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetUsagePlans

$result = $client->getUsagePlans([/* ... */]);
$promise = $client->getUsagePlansAsync([/* ... */]);

Gets all the usage plans of the caller's account.

Parameter Syntax

$result = $client->getUsagePlans([
    'keyId' => '<string>',
    'limit' => <integer>,
    'position' => '<string>',
]);

Parameter Details

Members
keyId
  • Type: string

The identifier of the API key associated with the usage plans.

limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

Result Syntax

[
    'items' => [
        [
            'apiStages' => [
                [
                    'apiId' => '<string>',
                    'stage' => '<string>',
                    'throttle' => [
                        '<String>' => [
                            'burstLimit' => <integer>,
                            'rateLimit' => <float>,
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'productCode' => '<string>',
            'quota' => [
                'limit' => <integer>,
                'offset' => <integer>,
                'period' => 'DAY|WEEK|MONTH',
            ],
            'tags' => ['<string>', ...],
            'throttle' => [
                'burstLimit' => <integer>,
                'rateLimit' => <float>,
            ],
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of UsagePlan structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

GetVpcLink

$result = $client->getVpcLink([/* ... */]);
$promise = $client->getVpcLinkAsync([/* ... */]);

Gets a specified VPC link under the caller's account in a region.

Parameter Syntax

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

Parameter Details

Members
vpcLinkId
  • Required: Yes
  • Type: string

[Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Result Syntax

[
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'status' => 'AVAILABLE|PENDING|DELETING|FAILED',
    'statusMessage' => '<string>',
    'tags' => ['<string>', ...],
    'targetArns' => ['<string>', ...],
]

Result Details

Members
description
  • Type: string

The description of the VPC link.

id
  • Type: string

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

name
  • Type: string

The name used to label and identify the VPC link.

status
  • Type: string

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

statusMessage
  • Type: string

A description about the VPC link status.

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

The collection of tags. Each tag element is associated with a given resource.

targetArns
  • Type: Array of strings

The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

GetVpcLinks

$result = $client->getVpcLinks([/* ... */]);
$promise = $client->getVpcLinksAsync([/* ... */]);

Gets the VpcLinks collection under the caller's account in a selected region.

Parameter Syntax

$result = $client->getVpcLinks([
    'limit' => <integer>,
    'position' => '<string>',
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
  • Type: string

The current pagination position in the paged result set.

Result Syntax

[
    'items' => [
        [
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'status' => 'AVAILABLE|PENDING|DELETING|FAILED',
            'statusMessage' => '<string>',
            'tags' => ['<string>', ...],
            'targetArns' => ['<string>', ...],
        ],
        // ...
    ],
    'position' => '<string>',
]

Result Details

Members
items
  • Type: Array of VpcLink structures

The current page of elements from this collection.

position
  • Type: string

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

ImportApiKeys

$result = $client->importApiKeys([/* ... */]);
$promise = $client->importApiKeysAsync([/* ... */]);

Import API keys from an external source, such as a CSV-formatted file.

Parameter Syntax

$result = $client->importApiKeys([
    'body' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'failOnWarnings' => true || false,
    'format' => 'csv', // REQUIRED
]);

Parameter Details

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

The payload of the POST request to import API keys. For the payload format, see API Key File Format.

failOnWarnings
  • Type: boolean

A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

format
  • Required: Yes
  • Type: string

A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

Result Syntax

[
    'ids' => ['<string>', ...],
    'warnings' => ['<string>', ...],
]

Result Details

Members
ids
  • Type: Array of strings

A list of all the ApiKey identifiers.

warnings
  • Type: Array of strings

A list of warning messages.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

ImportDocumentationParts

$result = $client->importDocumentationParts([/* ... */]);
$promise = $client->importDocumentationPartsAsync([/* ... */]);

Parameter Syntax

$result = $client->importDocumentationParts([
    'body' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'failOnWarnings' => true || false,
    'mode' => 'merge|overwrite',
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

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

[Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

failOnWarnings
  • Type: boolean

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

mode
  • Type: string

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'ids' => ['<string>', ...],
    'warnings' => ['<string>', ...],
]

Result Details

Members
ids
  • Type: Array of strings

A list of the returned documentation part identifiers.

warnings
  • Type: Array of strings

A list of warning messages reported during import of documentation parts.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

ImportRestApi

$result = $client->importRestApi([/* ... */]);
$promise = $client->importRestApiAsync([/* ... */]);

A feature of the API Gateway control service for creating a new API from an external API definition file.

Parameter Syntax

$result = $client->importRestApi([
    'body' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'failOnWarnings' => true || false,
    'parameters' => ['<string>', ...],
]);

Parameter Details

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

[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.

failOnWarnings
  • Type: boolean

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

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

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'

Result Syntax

[
    'apiKeySource' => 'HEADER|AUTHORIZER',
    'binaryMediaTypes' => ['<string>', ...],
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'endpointConfiguration' => [
        'types' => ['<string>', ...],
        'vpcEndpointIds' => ['<string>', ...],
    ],
    'id' => '<string>',
    'minimumCompressionSize' => <integer>,
    'name' => '<string>',
    'policy' => '<string>',
    'tags' => ['<string>', ...],
    'version' => '<string>',
    'warnings' => ['<string>', ...],
]

Result Details

Members
apiKeySource
  • Type: string

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

binaryMediaTypes
  • Type: Array of strings

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

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

The timestamp when the API was created.

description
  • Type: string

The API's description.

endpointConfiguration
  • Type: EndpointConfiguration structure

The endpoint configuration of this RestApi showing the endpoint types of the API.

id
  • Type: string

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

minimumCompressionSize
  • Type: int

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

name
  • Type: string

The API's name.

policy
  • Type: string
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
tags
  • Type: Associative array of custom strings keys (String) to strings

The collection of tags. Each tag element is associated with a given resource.

version
  • Type: string

A version identifier for the API.

warnings
  • Type: Array of strings

The warning messages reported when failonwarnings is turned on during API import.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

PutGatewayResponse

$result = $client->putGatewayResponse([/* ... */]);
$promise = $client->putGatewayResponseAsync([/* ... */]);

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

Parameter Syntax

$result = $client->putGatewayResponse([
    'responseParameters' => ['<string>', ...],
    'responseTemplates' => ['<string>', ...],
    'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
    'statusCode' => '<string>',
]);

Parameter Details

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

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

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

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

responseType
  • Required: Yes
  • Type: string

[Required]

The response type of the associated GatewayResponse. Valid values are

  • ACCESS_DENIED
  • API_CONFIGURATION_ERROR
  • AUTHORIZER_FAILURE
  • AUTHORIZER_CONFIGURATION_ERROR
  • BAD_REQUEST_PARAMETERS
  • BAD_REQUEST_BODY
  • DEFAULT_4XX
  • DEFAULT_5XX
  • EXPIRED_TOKEN
  • INVALID_SIGNATURE
  • INTEGRATION_FAILURE
  • INTEGRATION_TIMEOUT
  • INVALID_API_KEY
  • MISSING_AUTHENTICATION_TOKEN
  • QUOTA_EXCEEDED
  • REQUEST_TOO_LARGE
  • RESOURCE_NOT_FOUND
  • THROTTLED
  • UNAUTHORIZED
  • UNSUPPORTED_MEDIA_TYPE

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

statusCode
  • Type: string
The HTTP status code of the GatewayResponse.

Result Syntax

[
    'defaultResponse' => true || false,
    'responseParameters' => ['<string>', ...],
    'responseTemplates' => ['<string>', ...],
    'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED',
    'statusCode' => '<string>',
]

Result Details

Members
defaultResponse
  • Type: boolean

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

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

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

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

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

responseType
  • Type: string

The response type of the associated GatewayResponse. Valid values are

  • ACCESS_DENIED
  • API_CONFIGURATION_ERROR
  • AUTHORIZER_FAILURE
  • AUTHORIZER_CONFIGURATION_ERROR
  • BAD_REQUEST_PARAMETERS
  • BAD_REQUEST_BODY
  • DEFAULT_4XX
  • DEFAULT_5XX
  • EXPIRED_TOKEN
  • INVALID_SIGNATURE
  • INTEGRATION_FAILURE
  • INTEGRATION_TIMEOUT
  • INVALID_API_KEY
  • MISSING_AUTHENTICATION_TOKEN
  • QUOTA_EXCEEDED
  • REQUEST_TOO_LARGE
  • RESOURCE_NOT_FOUND
  • THROTTLED
  • UNAUTHORIZED
  • UNSUPPORTED_MEDIA_TYPE

statusCode
  • Type: string

The HTTP status code for this GatewayResponse.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

PutIntegration

$result = $client->putIntegration([/* ... */]);
$promise = $client->putIntegrationAsync([/* ... */]);

Sets up a method's integration.

Parameter Syntax

$result = $client->putIntegration([
    'cacheKeyParameters' => ['<string>', ...],
    'cacheNamespace' => '<string>',
    'connectionId' => '<string>',
    'connectionType' => 'INTERNET|VPC_LINK',
    'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'credentials' => '<string>',
    'httpMethod' => '<string>', // REQUIRED
    'integrationHttpMethod' => '<string>',
    'passthroughBehavior' => '<string>',
    'requestParameters' => ['<string>', ...],
    'requestTemplates' => ['<string>', ...],
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
    'timeoutInMillis' => <integer>,
    'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY', // REQUIRED
    'uri' => '<string>',
]);

Parameter Details

Members
cacheKeyParameters
  • Type: Array of strings

An API-specific tag group of related cached parameters.

cacheNamespace
  • Type: string

A list of request parameters whose values are to be cached.

connectionId
  • Type: string

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

connectionType
  • Type: string

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

contentHandling
  • Type: string

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

credentials
  • Type: string

Specifies whether credentials are required for a put integration.

httpMethod
  • Required: Yes
  • Type: string

[Required] Specifies a put integration request's HTTP method.

integrationHttpMethod
  • Type: string

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

passthroughBehavior
  • Type: string

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

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

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

resourceId
  • Required: Yes
  • Type: string

[Required] Specifies a put integration request's resource ID.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

timeoutInMillis
  • Type: int

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

type
  • Required: Yes
  • Type: string

[Required] Specifies a put integration input's type.

uri
  • Type: string

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Result Syntax

[
    'cacheKeyParameters' => ['<string>', ...],
    'cacheNamespace' => '<string>',
    'connectionId' => '<string>',
    'connectionType' => 'INTERNET|VPC_LINK',
    'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'credentials' => '<string>',
    'httpMethod' => '<string>',
    'integrationResponses' => [
        '<String>' => [
            'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
            'responseParameters' => ['<string>', ...],
            'responseTemplates' => ['<string>', ...],
            'selectionPattern' => '<string>',
            'statusCode' => '<string>',
        ],
        // ...
    ],
    'passthroughBehavior' => '<string>',
    'requestParameters' => ['<string>', ...],
    'requestTemplates' => ['<string>', ...],
    'timeoutInMillis' => <integer>,
    'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY',
    'uri' => '<string>',
]

Result Details

Members
cacheKeyParameters
  • Type: Array of strings

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

cacheNamespace
  • Type: string

An API-specific tag group of related cached parameters. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

connectionId
  • Type: string

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

connectionType
  • Type: string

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

contentHandling
  • Type: string

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

credentials
  • Type: string

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.

httpMethod
  • Type: string

Specifies the integration's HTTP method type.

integrationResponses
  • Type: Associative array of custom strings keys (String) to IntegrationResponse structures

Specifies the integration's responses.

Example: Get integration responses of a method

Request

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response

The successful response returns 200 OK status and a payload as follows:

{ "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }

Creating an API
passthroughBehavior
  • Type: string

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:

  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
requestParameters
  • Type: Associative array of custom strings keys (String) to strings

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

timeoutInMillis
  • Type: int

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

type
  • Type: string

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

uri
  • Type: string

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

PutIntegrationResponse

$result = $client->putIntegrationResponse([/* ... */]);
$promise = $client->putIntegrationResponseAsync([/* ... */]);

Represents a put integration.

Parameter Syntax

$result = $client->putIntegrationResponse([
    'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'httpMethod' => '<string>', // REQUIRED
    'resourceId' => '<string>', // REQUIRED
    'responseParameters' => ['<string>', ...],
    'responseTemplates' => ['<string>', ...],
    'restApiId' => '<string>', // REQUIRED
    'selectionPattern' => '<string>',
    'statusCode' => '<string>', // REQUIRED
]);

Parameter Details

Members
contentHandling
  • Type: string

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

httpMethod
  • Required: Yes
  • Type: string

[Required] Specifies a put integration response request's HTTP method.

resourceId
  • Required: Yes
  • Type: string

[Required] Specifies a put integration response request's resource identifier.

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

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

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

Specifies a put integration response's templates.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

selectionPattern
  • Type: string

Specifies the selection pattern of a put integration response.

statusCode
  • Required: Yes
  • Type: string

[Required] Specifies the status code that is used to map the integration response to an existing MethodResponse.

Result Syntax

[
    'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'responseParameters' => ['<string>', ...],
    'responseTemplates' => ['<string>', ...],
    'selectionPattern' => '<string>',
    'statusCode' => '<string>',
]

Result Details

Members
contentHandling
  • Type: string

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

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

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

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

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

selectionPattern
  • Type: string

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

statusCode
  • Type: string

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

PutMethod

$result = $client->putMethod([/* ... */]);
$promise = $client->putMethodAsync([/* ... */]);

Add a method to an existing Resource resource.

Parameter Syntax

$result = $client->putMethod([
    'apiKeyRequired' => true || false,
    'authorizationScopes' => ['<string>', ...],
    'authorizationType' => '<string>', // REQUIRED
    'authorizerId' => '<string>',
    'httpMethod' => '<string>', // REQUIRED
    'operationName' => '<string>',
    'requestModels' => ['<string>', ...],
    'requestParameters' => [true || false, ...],
    'requestValidatorId' => '<string>',
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
apiKeyRequired
  • Type: boolean

Specifies whether the method required a valid ApiKey.

authorizationScopes
  • Type: Array of strings

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

authorizationType
  • Required: Yes
  • Type: string

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

authorizerId
  • Type: string

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

httpMethod
  • Required: Yes
  • Type: string

[Required] Specifies the method request's HTTP method type.

operationName
  • Type: string

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

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

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

requestValidatorId
  • Type: string

The identifier of a RequestValidator for validating the method request.

resourceId
  • Required: Yes
  • Type: string

[Required] The Resource identifier for the new Method resource.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'apiKeyRequired' => true || false,
    'authorizationScopes' => ['<string>', ...],
    'authorizationType' => '<string>',
    'authorizerId' => '<string>',
    'httpMethod' => '<string>',
    'methodIntegration' => [
        'cacheKeyParameters' => ['<string>', ...],
        'cacheNamespace' => '<string>',
        'connectionId' => '<string>',
        'connectionType' => 'INTERNET|VPC_LINK',
        'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
        'credentials' => '<string>',
        'httpMethod' => '<string>',
        'integrationResponses' => [
            '<String>' => [
                'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
                'responseParameters' => ['<string>', ...],
                'responseTemplates' => ['<string>', ...],
                'selectionPattern' => '<string>',
                'statusCode' => '<string>',
            ],
            // ...
        ],
        'passthroughBehavior' => '<string>',
        'requestParameters' => ['<string>', ...],
        'requestTemplates' => ['<string>', ...],
        'timeoutInMillis' => <integer>,
        'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY',
        'uri' => '<string>',
    ],
    'methodResponses' => [
        '<String>' => [
            'responseModels' => ['<string>', ...],
            'responseParameters' => [true || false, ...],
            'statusCode' => '<string>',
        ],
        // ...
    ],
    'operationName' => '<string>',
    'requestModels' => ['<string>', ...],
    'requestParameters' => [true || false, ...],
    'requestValidatorId' => '<string>',
]

Result Details

Members
apiKeyRequired
  • Type: boolean

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

authorizationScopes
  • Type: Array of strings

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

authorizationType
  • Type: string

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

authorizerId
  • Type: string

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

httpMethod
  • Type: string

The method's HTTP verb.

methodIntegration
  • Type: Integration structure

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } }

AWS CLI
methodResponses
  • Type: Associative array of custom strings keys (String) to MethodResponse structures

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }

AWS CLI
operationName
  • Type: string

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

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

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

requestValidatorId
  • Type: string

The identifier of a RequestValidator for request validation.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

PutMethodResponse

$result = $client->putMethodResponse([/* ... */]);
$promise = $client->putMethodResponseAsync([/* ... */]);

Adds a MethodResponse to an existing Method resource.

Parameter Syntax

$result = $client->putMethodResponse([
    'httpMethod' => '<string>', // REQUIRED
    'resourceId' => '<string>', // REQUIRED
    'responseModels' => ['<string>', ...],
    'responseParameters' => [true || false, ...],
    'restApiId' => '<string>', // REQUIRED
    'statusCode' => '<string>', // REQUIRED
]);

Parameter Details

Members
httpMethod
  • Required: Yes
  • Type: string

[Required] The HTTP verb of the Method resource.

resourceId
  • Required: Yes
  • Type: string

[Required] The Resource identifier for the Method resource.

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

Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

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

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

statusCode
  • Required: Yes
  • Type: string

[Required] The method response's status code.

Result Syntax

[
    'responseModels' => ['<string>', ...],
    'responseParameters' => [true || false, ...],
    'statusCode' => '<string>',
]

Result Details

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

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

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

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

statusCode
  • Type: string

The method response's status code.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

PutRestApi

$result = $client->putRestApi([/* ... */]);
$promise = $client->putRestApiAsync([/* ... */]);

A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

Parameter Syntax

$result = $client->putRestApi([
    'body' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'failOnWarnings' => true || false,
    'mode' => 'merge|overwrite',
    'parameters' => ['<string>', ...],
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

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

[Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.

failOnWarnings
  • Type: boolean

A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.

mode
  • Type: string

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'apiKeySource' => 'HEADER|AUTHORIZER',
    'binaryMediaTypes' => ['<string>', ...],
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'endpointConfiguration' => [
        'types' => ['<string>', ...],
        'vpcEndpointIds' => ['<string>', ...],
    ],
    'id' => '<string>',
    'minimumCompressionSize' => <integer>,
    'name' => '<string>',
    'policy' => '<string>',
    'tags' => ['<string>', ...],
    'version' => '<string>',
    'warnings' => ['<string>', ...],
]

Result Details

Members
apiKeySource
  • Type: string

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

binaryMediaTypes
  • Type: Array of strings

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

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

The timestamp when the API was created.

description
  • Type: string

The API's description.

endpointConfiguration
  • Type: EndpointConfiguration structure

The endpoint configuration of this RestApi showing the endpoint types of the API.

id
  • Type: string

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

minimumCompressionSize
  • Type: int

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

name
  • Type: string

The API's name.

policy
  • Type: string
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
tags
  • Type: Associative array of custom strings keys (String) to strings

The collection of tags. Each tag element is associated with a given resource.

version
  • Type: string

A version identifier for the API.

warnings
  • Type: Array of strings

The warning messages reported when failonwarnings is turned on during API import.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

TagResource

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

Adds or updates a tag on a given resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.

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

[Required] The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

TestInvokeAuthorizer

$result = $client->testInvokeAuthorizer([/* ... */]);
$promise = $client->testInvokeAuthorizerAsync([/* ... */]);

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer

Parameter Syntax

$result = $client->testInvokeAuthorizer([
    'additionalContext' => ['<string>', ...],
    'authorizerId' => '<string>', // REQUIRED
    'body' => '<string>',
    'headers' => ['<string>', ...],
    'multiValueHeaders' => [
        '<String>' => ['<string>', ...],
        // ...
    ],
    'pathWithQueryString' => '<string>',
    'restApiId' => '<string>', // REQUIRED
    'stageVariables' => ['<string>', ...],
]);

Parameter Details

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

[Optional] A key-value map of additional context variables.

authorizerId
  • Required: Yes
  • Type: string

[Required] Specifies a test invoke authorizer request's Authorizer ID.

body
  • Type: string

[Optional] The simulated request body of an incoming invocation request.

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

[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

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

[Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.

pathWithQueryString
  • Type: string

[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

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

A key-value map of stage variables to simulate an invocation on a deployed Stage.

Result Syntax

[
    'authorization' => [
        '<String>' => ['<string>', ...],
        // ...
    ],
    'claims' => ['<string>', ...],
    'clientStatus' => <integer>,
    'latency' => <integer>,
    'log' => '<string>',
    'policy' => '<string>',
    'principalId' => '<string>',
]

Result Details

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

The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.

clientStatus
  • Type: int

The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

latency
  • Type: long (int|float)

The execution latency of the test authorizer request.

log
  • Type: string

The API Gateway execution log for the test authorizer request.

policy
  • Type: string

The JSON policy document returned by the Authorizer

principalId
  • Type: string

The principal identity returned by the Authorizer

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

TestInvokeMethod

$result = $client->testInvokeMethod([/* ... */]);
$promise = $client->testInvokeMethodAsync([/* ... */]);

Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.

Parameter Syntax

$result = $client->testInvokeMethod([
    'body' => '<string>',
    'clientCertificateId' => '<string>',
    'headers' => ['<string>', ...],
    'httpMethod' => '<string>', // REQUIRED
    'multiValueHeaders' => [
        '<String>' => ['<string>', ...],
        // ...
    ],
    'pathWithQueryString' => '<string>',
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
    'stageVariables' => ['<string>', ...],
]);

Parameter Details

Members
body
  • Type: string

The simulated request body of an incoming invocation request.

clientCertificateId
  • Type: string

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

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

A key-value map of headers to simulate an incoming invocation request.

httpMethod
  • Required: Yes
  • Type: string

[Required] Specifies a test invoke method request's HTTP method.

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

The headers as a map from string to list of values to simulate an incoming invocation request.

pathWithQueryString
  • Type: string

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

resourceId
  • Required: Yes
  • Type: string

[Required] Specifies a test invoke method request's resource ID.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

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

A key-value map of stage variables to simulate an invocation on a deployed Stage.

Result Syntax

[
    'body' => '<string>',
    'headers' => ['<string>', ...],
    'latency' => <integer>,
    'log' => '<string>',
    'multiValueHeaders' => [
        '<String>' => ['<string>', ...],
        // ...
    ],
    'status' => <integer>,
]

Result Details

Members
body
  • Type: string

The body of the HTTP response.

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

The headers of the HTTP response.

latency
  • Type: long (int|float)

The execution latency of the test invoke request.

log
  • Type: string

The API Gateway execution log for the test invoke request.

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

The headers of the HTTP response as a map from string to list of values.

status
  • Type: int

The HTTP status code.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UntagResource

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

Removes a tag from a given resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.

tagKeys
  • Required: Yes
  • Type: Array of strings

[Required] The Tag keys to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

UpdateAccount

$result = $client->updateAccount([/* ... */]);
$promise = $client->updateAccountAsync([/* ... */]);

Changes information about the current Account resource.

Parameter Syntax

$result = $client->updateAccount([
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

Result Syntax

[
    'apiKeyVersion' => '<string>',
    'cloudwatchRoleArn' => '<string>',
    'features' => ['<string>', ...],
    'throttleSettings' => [
        'burstLimit' => <integer>,
        'rateLimit' => <float>,
    ],
]

Result Details

Members
apiKeyVersion
  • Type: string

The version of the API keys used for the account.

cloudwatchRoleArn
  • Type: string

The ARN of an Amazon CloudWatch role for the current Account.

features
  • Type: Array of strings

A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".

throttleSettings
  • Type: ThrottleSettings structure

Specifies the API request limits configured for the current Account.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateApiKey

$result = $client->updateApiKey([/* ... */]);
$promise = $client->updateApiKeyAsync([/* ... */]);

Changes information about an ApiKey resource.

Parameter Syntax

$result = $client->updateApiKey([
    'apiKey' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
apiKey
  • Required: Yes
  • Type: string

[Required] The identifier of the ApiKey resource to be updated.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

Result Syntax

[
    'createdDate' => <DateTime>,
    'customerId' => '<string>',
    'description' => '<string>',
    'enabled' => true || false,
    'id' => '<string>',
    'lastUpdatedDate' => <DateTime>,
    'name' => '<string>',
    'stageKeys' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'value' => '<string>',
]

Result Details

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

The timestamp when the API Key was created.

customerId
  • Type: string

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

description
  • Type: string

The description of the API Key.

enabled
  • Type: boolean

Specifies whether the API Key can be used by callers.

id
  • Type: string

The identifier of the API Key.

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

The timestamp when the API Key was last updated.

name
  • Type: string

The name of the API Key.

stageKeys
  • Type: Array of strings

A list of Stage resources that are associated with the ApiKey resource.

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

The collection of tags. Each tag element is associated with a given resource.

value
  • Type: string

The value of the API Key.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

UpdateAuthorizer

$result = $client->updateAuthorizer([/* ... */]);
$promise = $client->updateAuthorizerAsync([/* ... */]);

Updates an existing Authorizer resource.

AWS CLI

Parameter Syntax

$result = $client->updateAuthorizer([
    'authorizerId' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
authorizerId
  • Required: Yes
  • Type: string

[Required] The identifier of the Authorizer resource.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'authType' => '<string>',
    'authorizerCredentials' => '<string>',
    'authorizerResultTtlInSeconds' => <integer>,
    'authorizerUri' => '<string>',
    'id' => '<string>',
    'identitySource' => '<string>',
    'identityValidationExpression' => '<string>',
    'name' => '<string>',
    'providerARNs' => ['<string>', ...],
    'type' => 'TOKEN|REQUEST|COGNITO_USER_POOLS',
]

Result Details

Members
authType
  • Type: string

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

authorizerCredentials
  • Type: string

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

authorizerResultTtlInSeconds
  • Type: int

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

authorizerUri
  • Type: string

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

id
  • Type: string

The identifier for the authorizer resource.

identitySource
  • Type: string

The identity source for which authorization is requested.

  • For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
  • For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

identityValidationExpression
  • Type: string

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

name
  • Type: string

[Required] The name of the authorizer.

providerARNs
  • Type: Array of strings

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

type
  • Type: string

The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateBasePathMapping

$result = $client->updateBasePathMapping([/* ... */]);
$promise = $client->updateBasePathMappingAsync([/* ... */]);

Changes information about the BasePathMapping resource.

Parameter Syntax

$result = $client->updateBasePathMapping([
    'basePath' => '<string>', // REQUIRED
    'domainName' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
basePath
  • Required: Yes
  • Type: string

[Required] The base path of the BasePathMapping resource to change.

To specify an empty base path, set this parameter to '(none)'.

domainName
  • Required: Yes
  • Type: string

[Required] The domain name of the BasePathMapping resource to change.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

Result Syntax

[
    'basePath' => '<string>',
    'restApiId' => '<string>',
    'stage' => '<string>',
]

Result Details

Members
basePath
  • Type: string

The base path name that callers of the API must provide as part of the URL after the domain name.

restApiId
  • Type: string

The string identifier of the associated RestApi.

stage
  • Type: string

The name of the associated stage.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateClientCertificate

$result = $client->updateClientCertificate([/* ... */]);
$promise = $client->updateClientCertificateAsync([/* ... */]);

Changes information about an ClientCertificate resource.

Parameter Syntax

$result = $client->updateClientCertificate([
    'clientCertificateId' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
clientCertificateId
  • Required: Yes
  • Type: string

[Required] The identifier of the ClientCertificate resource to be updated.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

Result Syntax

[
    'clientCertificateId' => '<string>',
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'expirationDate' => <DateTime>,
    'pemEncodedCertificate' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members
clientCertificateId
  • Type: string

The identifier of the client certificate.

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

The timestamp when the client certificate was created.

description
  • Type: string

The description of the client certificate.

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

The timestamp when the client certificate will expire.

pemEncodedCertificate
  • Type: string

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

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

The collection of tags. Each tag element is associated with a given resource.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

UpdateDeployment

$result = $client->updateDeployment([/* ... */]);
$promise = $client->updateDeploymentAsync([/* ... */]);

Changes information about a Deployment resource.

Parameter Syntax

$result = $client->updateDeployment([
    'deploymentId' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
deploymentId
  • Required: Yes
  • Type: string

The replacement identifier for the Deployment resource to change information about.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'apiSummary' => [
        '<String>' => [
            '<String>' => [
                'apiKeyRequired' => true || false,
                'authorizationType' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
]

Result Details

Members
apiSummary
  • Type: Associative array of custom strings keys (String) to MethodSnapshot structuress

A summary of the RestApi at the date and time that the deployment resource was created.

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

The date and time that the deployment resource was created.

description
  • Type: string

The description for the deployment resource.

id
  • Type: string

The identifier for the deployment resource.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • ServiceUnavailableException:

    The requested service is not available. For details see the accompanying error message. Retry after the specified time period.

UpdateDocumentationPart

$result = $client->updateDocumentationPart([/* ... */]);
$promise = $client->updateDocumentationPartAsync([/* ... */]);

Parameter Syntax

$result = $client->updateDocumentationPart([
    'documentationPartId' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
documentationPartId
  • Required: Yes
  • Type: string

[Required] The identifier of the to-be-updated documentation part.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'id' => '<string>',
    'location' => [
        'method' => '<string>',
        'name' => '<string>',
        'path' => '<string>',
        'statusCode' => '<string>',
        'type' => 'API|AUTHORIZER|MODEL|RESOURCE|METHOD|PATH_PARAMETER|QUERY_PARAMETER|REQUEST_HEADER|REQUEST_BODY|RESPONSE|RESPONSE_HEADER|RESPONSE_BODY',
    ],
    'properties' => '<string>',
]

Result Details

Members
id
  • Type: string

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

location
  • Type: DocumentationPartLocation structure

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

properties
  • Type: string

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

Errors

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateDocumentationVersion

$result = $client->updateDocumentationVersion([/* ... */]);
$promise = $client->updateDocumentationVersionAsync([/* ... */]);

Parameter Syntax

$result = $client->updateDocumentationVersion([
    'documentationVersion' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
documentationVersion
  • Required: Yes
  • Type: string

[Required] The version identifier of the to-be-updated documentation version.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi..

Result Syntax

[
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'version' => '<string>',
]

Result Details

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

The date when the API documentation snapshot is created.

description
  • Type: string

The description of the API documentation snapshot.

version
  • Type: string

The version identifier of the API documentation snapshot.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateDomainName

$result = $client->updateDomainName([/* ... */]);
$promise = $client->updateDomainNameAsync([/* ... */]);

Changes information about the DomainName resource.

Parameter Syntax

$result = $client->updateDomainName([
    'domainName' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
domainName
  • Required: Yes
  • Type: string

[Required] The name of the DomainName resource to be changed.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

Result Syntax

[
    'certificateArn' => '<string>',
    'certificateName' => '<string>',
    'certificateUploadDate' => <DateTime>,
    'distributionDomainName' => '<string>',
    'distributionHostedZoneId' => '<string>',
    'domainName' => '<string>',
    'domainNameStatus' => 'AVAILABLE|UPDATING|PENDING',
    'domainNameStatusMessage' => '<string>',
    'endpointConfiguration' => [
        'types' => ['<string>', ...],
        'vpcEndpointIds' => ['<string>', ...],
    ],
    'regionalCertificateArn' => '<string>',
    'regionalCertificateName' => '<string>',
    'regionalDomainName' => '<string>',
    'regionalHostedZoneId' => '<string>',
    'securityPolicy' => 'TLS_1_0|TLS_1_2',
    'tags' => ['<string>', ...],
]

Result Details

Members
certificateArn
  • Type: string

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

certificateName
  • Type: string

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

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

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

distributionDomainName
  • Type: string

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

distributionHostedZoneId
  • Type: string

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainName
  • Type: string

The custom domain name as an API host name, for example, my-api.example.com.

domainNameStatus
  • Type: string

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

domainNameStatusMessage
  • Type: string

An optional text message containing detailed information about status of the DomainName migration.

endpointConfiguration
  • Type: EndpointConfiguration structure

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

regionalCertificateArn
  • Type: string

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

regionalCertificateName
  • Type: string

The name of the certificate that will be used for validating the regional domain name.

regionalDomainName
  • Type: string

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

regionalHostedZoneId
  • Type: string

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

securityPolicy
  • Type: string

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

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

The collection of tags. Each tag element is associated with a given resource.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateGatewayResponse

$result = $client->updateGatewayResponse([/* ... */]);
$promise = $client->updateGatewayResponseAsync([/* ... */]);

Updates a GatewayResponse of a specified response type on the given RestApi.

Parameter Syntax

$result = $client->updateGatewayResponse([
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

responseType
  • Required: Yes
  • Type: string

[Required]

The response type of the associated GatewayResponse. Valid values are

  • ACCESS_DENIED
  • API_CONFIGURATION_ERROR
  • AUTHORIZER_FAILURE
  • AUTHORIZER_CONFIGURATION_ERROR
  • BAD_REQUEST_PARAMETERS
  • BAD_REQUEST_BODY
  • DEFAULT_4XX
  • DEFAULT_5XX
  • EXPIRED_TOKEN
  • INVALID_SIGNATURE
  • INTEGRATION_FAILURE
  • INTEGRATION_TIMEOUT
  • INVALID_API_KEY
  • MISSING_AUTHENTICATION_TOKEN
  • QUOTA_EXCEEDED
  • REQUEST_TOO_LARGE
  • RESOURCE_NOT_FOUND
  • THROTTLED
  • UNAUTHORIZED
  • UNSUPPORTED_MEDIA_TYPE

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'defaultResponse' => true || false,
    'responseParameters' => ['<string>', ...],
    'responseTemplates' => ['<string>', ...],
    'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED',
    'statusCode' => '<string>',
]

Result Details

Members
defaultResponse
  • Type: boolean

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

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

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

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

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

responseType
  • Type: string

The response type of the associated GatewayResponse. Valid values are

  • ACCESS_DENIED
  • API_CONFIGURATION_ERROR
  • AUTHORIZER_FAILURE
  • AUTHORIZER_CONFIGURATION_ERROR
  • BAD_REQUEST_PARAMETERS
  • BAD_REQUEST_BODY
  • DEFAULT_4XX
  • DEFAULT_5XX
  • EXPIRED_TOKEN
  • INVALID_SIGNATURE
  • INTEGRATION_FAILURE
  • INTEGRATION_TIMEOUT
  • INVALID_API_KEY
  • MISSING_AUTHENTICATION_TOKEN
  • QUOTA_EXCEEDED
  • REQUEST_TOO_LARGE
  • RESOURCE_NOT_FOUND
  • THROTTLED
  • UNAUTHORIZED
  • UNSUPPORTED_MEDIA_TYPE

statusCode
  • Type: string

The HTTP status code for this GatewayResponse.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateIntegration

$result = $client->updateIntegration([/* ... */]);
$promise = $client->updateIntegrationAsync([/* ... */]);

Represents an update integration.

Parameter Syntax

$result = $client->updateIntegration([
    'httpMethod' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
httpMethod
  • Required: Yes
  • Type: string

[Required] Represents an update integration request's HTTP method.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

resourceId
  • Required: Yes
  • Type: string

[Required] Represents an update integration request's resource identifier.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'cacheKeyParameters' => ['<string>', ...],
    'cacheNamespace' => '<string>',
    'connectionId' => '<string>',
    'connectionType' => 'INTERNET|VPC_LINK',
    'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'credentials' => '<string>',
    'httpMethod' => '<string>',
    'integrationResponses' => [
        '<String>' => [
            'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
            'responseParameters' => ['<string>', ...],
            'responseTemplates' => ['<string>', ...],
            'selectionPattern' => '<string>',
            'statusCode' => '<string>',
        ],
        // ...
    ],
    'passthroughBehavior' => '<string>',
    'requestParameters' => ['<string>', ...],
    'requestTemplates' => ['<string>', ...],
    'timeoutInMillis' => <integer>,
    'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY',
    'uri' => '<string>',
]

Result Details

Members
cacheKeyParameters
  • Type: Array of strings

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

cacheNamespace
  • Type: string

An API-specific tag group of related cached parameters. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

connectionId
  • Type: string

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

connectionType
  • Type: string

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

contentHandling
  • Type: string

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

credentials
  • Type: string

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.

httpMethod
  • Type: string

Specifies the integration's HTTP method type.

integrationResponses
  • Type: Associative array of custom strings keys (String) to IntegrationResponse structures

Specifies the integration's responses.

Example: Get integration responses of a method

Request

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response

The successful response returns 200 OK status and a payload as follows:

{ "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }

Creating an API
passthroughBehavior
  • Type: string

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:

  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
requestParameters
  • Type: Associative array of custom strings keys (String) to strings

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

timeoutInMillis
  • Type: int

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

type
  • Type: string

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

uri
  • Type: string

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

UpdateIntegrationResponse

$result = $client->updateIntegrationResponse([/* ... */]);
$promise = $client->updateIntegrationResponseAsync([/* ... */]);

Represents an update integration response.

Parameter Syntax

$result = $client->updateIntegrationResponse([
    'httpMethod' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
    'statusCode' => '<string>', // REQUIRED
]);

Parameter Details

Members
httpMethod
  • Required: Yes
  • Type: string

[Required] Specifies an update integration response request's HTTP method.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

resourceId
  • Required: Yes
  • Type: string

[Required] Specifies an update integration response request's resource identifier.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

statusCode
  • Required: Yes
  • Type: string

[Required] Specifies an update integration response request's status code.

Result Syntax

[
    'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'responseParameters' => ['<string>', ...],
    'responseTemplates' => ['<string>', ...],
    'selectionPattern' => '<string>',
    'statusCode' => '<string>',
]

Result Details

Members
contentHandling
  • Type: string

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

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

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

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

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

selectionPattern
  • Type: string

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

statusCode
  • Type: string

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateMethod

$result = $client->updateMethod([/* ... */]);
$promise = $client->updateMethodAsync([/* ... */]);

Updates an existing Method resource.

Parameter Syntax

$result = $client->updateMethod([
    'httpMethod' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
httpMethod
  • Required: Yes
  • Type: string

[Required] The HTTP verb of the Method resource.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

resourceId
  • Required: Yes
  • Type: string

[Required] The Resource identifier for the Method resource.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'apiKeyRequired' => true || false,
    'authorizationScopes' => ['<string>', ...],
    'authorizationType' => '<string>',
    'authorizerId' => '<string>',
    'httpMethod' => '<string>',
    'methodIntegration' => [
        'cacheKeyParameters' => ['<string>', ...],
        'cacheNamespace' => '<string>',
        'connectionId' => '<string>',
        'connectionType' => 'INTERNET|VPC_LINK',
        'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
        'credentials' => '<string>',
        'httpMethod' => '<string>',
        'integrationResponses' => [
            '<String>' => [
                'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
                'responseParameters' => ['<string>', ...],
                'responseTemplates' => ['<string>', ...],
                'selectionPattern' => '<string>',
                'statusCode' => '<string>',
            ],
            // ...
        ],
        'passthroughBehavior' => '<string>',
        'requestParameters' => ['<string>', ...],
        'requestTemplates' => ['<string>', ...],
        'timeoutInMillis' => <integer>,
        'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY',
        'uri' => '<string>',
    ],
    'methodResponses' => [
        '<String>' => [
            'responseModels' => ['<string>', ...],
            'responseParameters' => [true || false, ...],
            'statusCode' => '<string>',
        ],
        // ...
    ],
    'operationName' => '<string>',
    'requestModels' => ['<string>', ...],
    'requestParameters' => [true || false, ...],
    'requestValidatorId' => '<string>',
]

Result Details

Members
apiKeyRequired
  • Type: boolean

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

authorizationScopes
  • Type: Array of strings

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

authorizationType
  • Type: string

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

authorizerId
  • Type: string

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

httpMethod
  • Type: string

The method's HTTP verb.

methodIntegration
  • Type: Integration structure

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } }

AWS CLI
methodResponses
  • Type: Associative array of custom strings keys (String) to MethodResponse structures

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }

AWS CLI
operationName
  • Type: string

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

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

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

requestValidatorId
  • Type: string

The identifier of a RequestValidator for request validation.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateMethodResponse

$result = $client->updateMethodResponse([/* ... */]);
$promise = $client->updateMethodResponseAsync([/* ... */]);

Updates an existing MethodResponse resource.

Parameter Syntax

$result = $client->updateMethodResponse([
    'httpMethod' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
    'statusCode' => '<string>', // REQUIRED
]);

Parameter Details

Members
httpMethod
  • Required: Yes
  • Type: string

[Required] The HTTP verb of the Method resource.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

resourceId
  • Required: Yes
  • Type: string

[Required] The Resource identifier for the MethodResponse resource.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

statusCode
  • Required: Yes
  • Type: string

[Required] The status code for the MethodResponse resource.

Result Syntax

[
    'responseModels' => ['<string>', ...],
    'responseParameters' => [true || false, ...],
    'statusCode' => '<string>',
]

Result Details

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

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

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

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

statusCode
  • Type: string

The method response's status code.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • LimitExceededException:

    The request exceeded the rate limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateModel

$result = $client->updateModel([/* ... */]);
$promise = $client->updateModelAsync([/* ... */]);

Changes information about a model.

Parameter Syntax

$result = $client->updateModel([
    'modelName' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
modelName
  • Required: Yes
  • Type: string

[Required] The name of the model to update.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'contentType' => '<string>',
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'schema' => '<string>',
]

Result Details

Members
contentType
  • Type: string

The content-type for the model.

description
  • Type: string

The description of the model.

id
  • Type: string

The identifier for the model resource.

name
  • Type: string

The name of the model. Must be an alphanumeric string.

schema
  • Type: string

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateRequestValidator

$result = $client->updateRequestValidator([/* ... */]);
$promise = $client->updateRequestValidatorAsync([/* ... */]);

Updates a RequestValidator of a given RestApi.

Parameter Syntax

$result = $client->updateRequestValidator([
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'requestValidatorId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

requestValidatorId
  • Required: Yes
  • Type: string

[Required] The identifier of RequestValidator to be updated.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'id' => '<string>',
    'name' => '<string>',
    'validateRequestBody' => true || false,
    'validateRequestParameters' => true || false,
]

Result Details

Members
id
  • Type: string

The identifier of this RequestValidator.

name
  • Type: string

The name of this RequestValidator

validateRequestBody
  • Type: boolean

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

validateRequestParameters
  • Type: boolean

A Boolean flag to indicate whether to validate request parameters (true) or not (false).

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateResource

$result = $client->updateResource([/* ... */]);
$promise = $client->updateResourceAsync([/* ... */]);

Changes information about a Resource resource.

Parameter Syntax

$result = $client->updateResource([
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'resourceId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

resourceId
  • Required: Yes
  • Type: string

[Required] The identifier of the Resource resource.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'id' => '<string>',
    'parentId' => '<string>',
    'path' => '<string>',
    'pathPart' => '<string>',
    'resourceMethods' => [
        '<String>' => [
            'apiKeyRequired' => true || false,
            'authorizationScopes' => ['<string>', ...],
            'authorizationType' => '<string>',
            'authorizerId' => '<string>',
            'httpMethod' => '<string>',
            'methodIntegration' => [
                'cacheKeyParameters' => ['<string>', ...],
                'cacheNamespace' => '<string>',
                'connectionId' => '<string>',
                'connectionType' => 'INTERNET|VPC_LINK',
                'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
                'credentials' => '<string>',
                'httpMethod' => '<string>',
                'integrationResponses' => [
                    '<String>' => [
                        'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
                        'responseParameters' => ['<string>', ...],
                        'responseTemplates' => ['<string>', ...],
                        'selectionPattern' => '<string>',
                        'statusCode' => '<string>',
                    ],
                    // ...
                ],
                'passthroughBehavior' => '<string>',
                'requestParameters' => ['<string>', ...],
                'requestTemplates' => ['<string>', ...],
                'timeoutInMillis' => <integer>,
                'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY',
                'uri' => '<string>',
            ],
            'methodResponses' => [
                '<String>' => [
                    'responseModels' => ['<string>', ...],
                    'responseParameters' => [true || false, ...],
                    'statusCode' => '<string>',
                ],
                // ...
            ],
            'operationName' => '<string>',
            'requestModels' => ['<string>', ...],
            'requestParameters' => [true || false, ...],
            'requestValidatorId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
id
  • Type: string

The resource's identifier.

parentId
  • Type: string

The parent resource's identifier.

path
  • Type: string

The full path for this resource.

pathPart
  • Type: string

The last path segment for this resource.

resourceMethods
  • Type: Associative array of custom strings keys (String) to Method structures

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }

If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateRestApi

$result = $client->updateRestApi([/* ... */]);
$promise = $client->updateRestApiAsync([/* ... */]);

Changes information about the specified API.

Parameter Syntax

$result = $client->updateRestApi([
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'restApiId' => '<string>', // REQUIRED
]);

Parameter Details

Members
patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

Result Syntax

[
    'apiKeySource' => 'HEADER|AUTHORIZER',
    'binaryMediaTypes' => ['<string>', ...],
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'endpointConfiguration' => [
        'types' => ['<string>', ...],
        'vpcEndpointIds' => ['<string>', ...],
    ],
    'id' => '<string>',
    'minimumCompressionSize' => <integer>,
    'name' => '<string>',
    'policy' => '<string>',
    'tags' => ['<string>', ...],
    'version' => '<string>',
    'warnings' => ['<string>', ...],
]

Result Details

Members
apiKeySource
  • Type: string

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

binaryMediaTypes
  • Type: Array of strings

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

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

The timestamp when the API was created.

description
  • Type: string

The API's description.

endpointConfiguration
  • Type: EndpointConfiguration structure

The endpoint configuration of this RestApi showing the endpoint types of the API.

id
  • Type: string

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

minimumCompressionSize
  • Type: int

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

name
  • Type: string

The API's name.

policy
  • Type: string
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
tags
  • Type: Associative array of custom strings keys (String) to strings

The collection of tags. Each tag element is associated with a given resource.

version
  • Type: string

A version identifier for the API.

warnings
  • Type: Array of strings

The warning messages reported when failonwarnings is turned on during API import.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateStage

$result = $client->updateStage([/* ... */]);
$promise = $client->updateStageAsync([/* ... */]);

Changes information about a Stage resource.

Parameter Syntax

$result = $client->updateStage([
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'restApiId' => '<string>', // REQUIRED
    'stageName' => '<string>', // REQUIRED
]);

Parameter Details

Members
patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

restApiId
  • Required: Yes
  • Type: string

[Required] The string identifier of the associated RestApi.

stageName
  • Required: Yes
  • Type: string

[Required] The name of the Stage resource to change information about.

Result Syntax

[
    'accessLogSettings' => [
        'destinationArn' => '<string>',
        'format' => '<string>',
    ],
    'cacheClusterEnabled' => true || false,
    'cacheClusterSize' => '0.5|1.6|6.1|13.5|28.4|58.2|118|237',
    'cacheClusterStatus' => 'CREATE_IN_PROGRESS|AVAILABLE|DELETE_IN_PROGRESS|NOT_AVAILABLE|FLUSH_IN_PROGRESS',
    'canarySettings' => [
        'deploymentId' => '<string>',
        'percentTraffic' => <float>,
        'stageVariableOverrides' => ['<string>', ...],
        'useStageCache' => true || false,
    ],
    'clientCertificateId' => '<string>',
    'createdDate' => <DateTime>,
    'deploymentId' => '<string>',
    'description' => '<string>',
    'documentationVersion' => '<string>',
    'lastUpdatedDate' => <DateTime>,
    'methodSettings' => [
        '<String>' => [
            'cacheDataEncrypted' => true || false,
            'cacheTtlInSeconds' => <integer>,
            'cachingEnabled' => true || false,
            'dataTraceEnabled' => true || false,
            'loggingLevel' => '<string>',
            'metricsEnabled' => true || false,
            'requireAuthorizationForCacheControl' => true || false,
            'throttlingBurstLimit' => <integer>,
            'throttlingRateLimit' => <float>,
            'unauthorizedCacheControlHeaderStrategy' => 'FAIL_WITH_403|SUCCEED_WITH_RESPONSE_HEADER|SUCCEED_WITHOUT_RESPONSE_HEADER',
        ],
        // ...
    ],
    'stageName' => '<string>',
    'tags' => ['<string>', ...],
    'tracingEnabled' => true || false,
    'variables' => ['<string>', ...],
    'webAclArn' => '<string>',
]

Result Details

Members
accessLogSettings
  • Type: AccessLogSettings structure

Settings for logging access in this stage.

cacheClusterEnabled
  • Type: boolean

Specifies whether a cache cluster is enabled for the stage.

cacheClusterSize
  • Type: string

The size of the cache cluster for the stage, if enabled.

cacheClusterStatus
  • Type: string

The status of the cache cluster for the stage, if enabled.

canarySettings
  • Type: CanarySettings structure

Settings for the canary deployment in this stage.

clientCertificateId
  • Type: string

The identifier of a client certificate for an API stage.

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

The timestamp when the stage was created.

deploymentId
  • Type: string

The identifier of the Deployment that the stage points to.

description
  • Type: string

The stage's description.

documentationVersion
  • Type: string

The version of the associated API documentation.

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

The timestamp when the stage last updated.

methodSettings
  • Type: Associative array of custom strings keys (String) to MethodSetting structures

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

stageName
  • Type: string

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

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

The collection of tags. Each tag element is associated with a given resource.

tracingEnabled
  • Type: boolean

Specifies whether active tracing with X-ray is enabled for the Stage.

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

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

webAclArn
  • Type: string

The ARN of the WebAcl associated with the Stage.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

UpdateUsage

$result = $client->updateUsage([/* ... */]);
$promise = $client->updateUsageAsync([/* ... */]);

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

Parameter Syntax

$result = $client->updateUsage([
    'keyId' => '<string>', // REQUIRED
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'usagePlanId' => '<string>', // REQUIRED
]);

Parameter Details

Members
keyId
  • Required: Yes
  • Type: string

[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

usagePlanId
  • Required: Yes
  • Type: string

[Required] The Id of the usage plan associated with the usage data.

Result Syntax

[
    'endDate' => '<string>',
    'items' => [
        '<String>' => [
            [<integer>, ...],
            // ...
        ],
        // ...
    ],
    'position' => '<string>',
    'startDate' => '<string>',
    'usagePlanId' => '<string>',
]

Result Details

Members
endDate
  • Type: string

The ending date of the usage data.

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

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

position
  • Type: string
startDate
  • Type: string

The starting date of the usage data.

usagePlanId
  • Type: string

The plan Id associated with this usage data.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

UpdateUsagePlan

$result = $client->updateUsagePlan([/* ... */]);
$promise = $client->updateUsagePlanAsync([/* ... */]);

Updates a usage plan of a given plan Id.

Parameter Syntax

$result = $client->updateUsagePlan([
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'usagePlanId' => '<string>', // REQUIRED
]);

Parameter Details

Members
patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

usagePlanId
  • Required: Yes
  • Type: string

[Required] The Id of the to-be-updated usage plan.

Result Syntax

[
    'apiStages' => [
        [
            'apiId' => '<string>',
            'stage' => '<string>',
            'throttle' => [
                '<String>' => [
                    'burstLimit' => <integer>,
                    'rateLimit' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'productCode' => '<string>',
    'quota' => [
        'limit' => <integer>,
        'offset' => <integer>,
        'period' => 'DAY|WEEK|MONTH',
    ],
    'tags' => ['<string>', ...],
    'throttle' => [
        'burstLimit' => <integer>,
        'rateLimit' => <float>,
    ],
]

Result Details

Members
apiStages
  • Type: Array of ApiStage structures

The associated API stages of a usage plan.

description
  • Type: string

The description of a usage plan.

id
  • Type: string

The identifier of a UsagePlan resource.

name
  • Type: string

The name of a usage plan.

productCode
  • Type: string

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

quota
  • Type: QuotaSettings structure

The maximum number of permitted requests per a given unit time interval.

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

The collection of tags. Each tag element is associated with a given resource.

throttle
  • Type: ThrottleSettings structure

The request throttle limits of a usage plan.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

UpdateVpcLink

$result = $client->updateVpcLink([/* ... */]);
$promise = $client->updateVpcLinkAsync([/* ... */]);

Updates an existing VpcLink of a specified identifier.

Parameter Syntax

$result = $client->updateVpcLink([
    'patchOperations' => [
        [
            'from' => '<string>',
            'op' => 'add|remove|replace|move|copy|test',
            'path' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vpcLinkId' => '<string>', // REQUIRED
]);

Parameter Details

Members
patchOperations
  • Type: Array of PatchOperation structures

A list of update operations to be applied to the specified resource and in the order specified in this list.

vpcLinkId
  • Required: Yes
  • Type: string

[Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Result Syntax

[
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'status' => 'AVAILABLE|PENDING|DELETING|FAILED',
    'statusMessage' => '<string>',
    'tags' => ['<string>', ...],
    'targetArns' => ['<string>', ...],
]

Result Details

Members
description
  • Type: string

The description of the VPC link.

id
  • Type: string

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

name
  • Type: string

The name used to label and identify the VPC link.

status
  • Type: string

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

statusMessage
  • Type: string

A description about the VPC link status.

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

The collection of tags. Each tag element is associated with a given resource.

targetArns
  • Type: Array of strings

The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.

Errors

  • UnauthorizedException:

    The request is denied because the caller has insufficient permissions.

  • NotFoundException:

    The requested resource is not found. Make sure that the request URI is correct.

  • BadRequestException:

    The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException:

    The request configuration has conflicts. For details, see the accompanying error message.

  • TooManyRequestsException:

    The request has reached its throttling limit. Retry after the specified time period.

Shapes

AccessLogSettings

Description

Access log settings, including the access log format and access log destination ARN.

Members
destinationArn
  • Type: string

The ARN of the CloudWatch Logs log group to receive access logs.

format
  • Type: string

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

ApiStage

Description

API stage name of the associated API stage in a usage plan.

Members
apiId
  • Type: string

API Id of the associated API stage in a usage plan.

stage
  • Type: string

API stage name of the associated API stage in a usage plan.

throttle
  • Type: Associative array of custom strings keys (String) to ThrottleSettings structures

Map containing method level throttling information for API stage in a usage plan.

BadRequestException

Description

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

Members
message
  • Type: string

CanarySettings

Description

Configuration settings of a canary deployment.

Members
deploymentId
  • Type: string

The ID of the canary deployment.

percentTraffic
  • Type: double

The percent (0-100) of traffic diverted to a canary deployment.

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

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

useStageCache
  • Type: boolean

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

ConflictException

Description

The request configuration has conflicts. For details, see the accompanying error message.

Members
message
  • Type: string

DeploymentCanarySettings

Description

The input configuration for a canary deployment.

Members
percentTraffic
  • Type: double

The percentage (0.0-100.0) of traffic routed to the canary deployment.

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

A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.

useStageCache
  • Type: boolean

A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.

DocumentationPartLocation

Description

Specifies the target API entity to which the documentation applies.

Members
method
  • Type: string

The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.

name
  • Type: string

The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type.

path
  • Type: string

The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.

statusCode
  • Type: string

The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.

type
  • Required: Yes
  • Type: string

[Required] The type of API entity to which the documentation content applies. Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type.

EndpointConfiguration

Description

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

Members
types
  • Type: Array of strings

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

vpcEndpointIds
  • Type: Array of strings

A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

LimitExceededException

Description

The request exceeded the rate limit. Retry after the specified time period.

Members
message
  • Type: string
retryAfterSeconds
  • Type: string

MethodSetting

Description

Specifies the method setting properties.

Members
cacheDataEncrypted
  • Type: boolean

Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.

cacheTtlInSeconds
  • Type: int

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.

cachingEnabled
  • Type: boolean

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

dataTraceEnabled
  • Type: boolean

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

loggingLevel
  • Type: string

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO.

metricsEnabled
  • Type: boolean

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.

requireAuthorizationForCacheControl
  • Type: boolean

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.

throttlingBurstLimit
  • Type: int

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

throttlingRateLimit
  • Type: double

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

unauthorizedCacheControlHeaderStrategy
  • Type: string

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

MethodSnapshot

Description

Represents a summary of a Method resource, given a particular date and time.

Members
apiKeyRequired
  • Type: boolean

Specifies whether the method requires a valid ApiKey.

authorizationType
  • Type: string

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

NotFoundException

Description

The requested resource is not found. Make sure that the request URI is correct.

Members
message
  • Type: string

PatchOperation

Description
A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.
Members
from
  • Type: string

The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId".

op
  • Type: string

An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.

path
  • Type: string

The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.

value
  • Type: string

The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'. In a Windows shell, see Using JSON for Parameters.

QuotaSettings

Description

Quotas configured for a usage plan.

Members
limit
  • Type: int

The maximum number of requests that can be made in a given time period.

offset
  • Type: int

The number of requests subtracted from the given limit in the initial time period.

period
  • Type: string

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

SdkConfigurationProperty

Description

A configuration property of an SDK type.

Members
defaultValue
  • Type: string

The default value of an SdkType configuration property.

description
  • Type: string

The description of an SdkType configuration property.

friendlyName
  • Type: string

The user-friendly name of an SdkType configuration property.

name
  • Type: string

The name of a an SdkType configuration property.

required
  • Type: boolean

A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).

ServiceUnavailableException

Description

The requested service is not available. For details see the accompanying error message. Retry after the specified time period.

Members
message
  • Type: string
retryAfterSeconds
  • Type: string

StageKey

Description

A reference to a unique stage identified in the format {restApiId}/{stage}.

Members
restApiId
  • Type: string

The string identifier of the associated RestApi.

stageName
  • Type: string

The stage name associated with the stage key.

ThrottleSettings

Description

The API request rate limits.

Members
burstLimit
  • Type: int

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

rateLimit
  • Type: double

The API request steady-state rate limit.

TooManyRequestsException

Description

The request has reached its throttling limit. Retry after the specified time period.

Members
message
  • Type: string
retryAfterSeconds
  • Type: string

UnauthorizedException

Description

The request is denied because the caller has insufficient permissions.

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