2018-12-03 10:59:49 -08:00
< ? php
2020-04-02 15:46:13 -07:00
/*
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
2019-01-30 18:35:51 -08:00
// snippet-start:[apigateway.php.get_base_path_mapping.complete]
// snippet-start:[apigateway.php.get_base_path_mapping.import]
2018-12-03 10:59:49 -08:00
require 'vendor/autoload.php' ;
2020-04-02 15:46:13 -07:00
use Aws\ApiGateway\ApiGatewayClient ;
2018-12-03 10:59:49 -08:00
use Aws\Exception\AwsException ;
2019-01-30 18:35:51 -08:00
// snippet-end:[apigateway.php.get_base_path_mapping.import]
2018-12-03 10:59:49 -08:00
2020-04-15 14:25:50 -07:00
/* ////////////////////////////////////////////////////////////////////////////
* Purpose: Gets the base path mapping for a custom domain name in
* Amazon API Gateway.
*
* Prerequisites: A custom domain name in API Gateway. For more information,
* see "Custom Domain Names" in the Amazon API Gateway Developer Guide.
*
* Inputs:
* - $apiGatewayClient: An initialized PHP SDK API client for API Gateway.
* - $basePath: The base path name that callers must provide as part of the
* URL after the domain name.
* - $domainName: The custom domain name for the base path mapping.
*
* Returns: The base path mapping if available; otherwise the error message.
* ///////////////////////////////////////////////////////////////////////// */
2019-01-30 18:35:51 -08:00
//snippet-start:[apigateway.php.get_base_path_mapping.main]
2020-04-15 14:25:50 -07:00
function getBasePathMapping ( $apiGatewayClient , $basePath , $domainName )
2020-04-02 15:46:13 -07:00
{
2020-04-15 14:25:50 -07:00
try {
$result = $apiGatewayClient -> getBasePathMapping ([
'basePath' => $basePath ,
'domainName' => $domainName ,
]);
return 'The base path mapping\'s effective URI is: ' .
$result [ '@metadata' ][ 'effectiveUri' ];
} catch ( AwsException $e ) {
return 'Error: ' . $e [ 'message' ];
2020-04-02 15:46:13 -07:00
}
2020-04-15 14:25:50 -07:00
}
2020-04-02 15:46:13 -07:00
2020-04-15 14:25:50 -07:00
function getsTheBasePathMapping ()
{
$apiGatewayClient = new ApiGatewayClient ([
'profile' => 'default' ,
'region' => 'us-east-1' ,
'version' => '2015-07-09'
]);
echo getBasePathMapping ( $apiGatewayClient , '(none)' , 'example.com' );
}
2020-04-02 15:46:13 -07:00
2020-04-15 14:25:50 -07:00
// Uncomment the following line to run this code in an AWS account.
// getsTheBasePathMapping();
2019-01-30 18:35:51 -08:00
// snippet-end:[apigateway.php.get_base_path_mapping.main]
// snippet-end:[apigateway.php.get_base_path_mapping.complete]
2019-01-18 00:02:57 -08:00
// snippet-comment:[These are tags for the AWS doc team's sample catalog. Do not remove.]
// snippet-sourcedescription:[Get_BasePathmapping.php demonstrates how to view Base Path Mapping in API Gateway.]
2020-04-02 15:46:13 -07:00
// snippet-keyword:[PHP]
2019-09-05 20:04:44 -07:00
// snippet-sourcesyntax:[php]
2019-01-18 00:02:57 -08:00
// snippet-keyword:[AWS SDK for PHP v3]
// snippet-keyword:[Code Sample]
// snippet-keyword:[Amazon API Gateway]
// snippet-service:[apigateway]
// snippet-sourcetype:[full-example]
2020-04-15 14:25:50 -07:00
// snippet-sourcedate:[2020-04-13]
2020-04-02 15:46:13 -07:00
// snippet-sourceauthor:[pccornel (AWS)]
2018-12-03 10:59:49 -08:00
