Amazon API Gateway 2015-07-09

CreateApiKey

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

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

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

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([/* ... */]);

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

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

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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([/* ... */]);

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

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

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

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

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([/* ... */]);

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

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

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([/* ... */]);

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

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

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([/* ... */]);

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

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

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

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

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details