CreateApiKey

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

Create an ApiKey resource.

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

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.

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.

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.

CreateAuthorizer

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

Adds a new Authorizer resource to an existing RestApi resource.

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.

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.

NotFoundException:

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

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.

CreateBasePathMapping

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

Creates a new BasePathMapping resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'basePath' => '<string>',
    'restApiId' => '<string>',
    'stage' => '<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.

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.

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.

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

Result Syntax

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

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.

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.

CreateDocumentationPart

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

Creates a documentation part.

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.

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.

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.

CreateDocumentationVersion

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

Creates a documentation version

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.

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.

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.

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>', ...],
    ],
    'mutualTlsAuthentication' => [
        'truststoreUri' => '<string>',
        'truststoreVersion' => '<string>',
    ],
    'ownershipVerificationCertificateArn' => '<string>',
    'policy' => '<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>',
    'domainNameArn' => '<string>',
    'domainNameId' => '<string>',
    'domainNameStatus' => 'AVAILABLE|UPDATING|PENDING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION',
    'domainNameStatusMessage' => '<string>',
    'endpointConfiguration' => [
        'types' => ['<string>', ...],
        'vpcEndpointIds' => ['<string>', ...],
    ],
    'managementPolicy' => '<string>',
    'mutualTlsAuthentication' => [
        'truststoreUri' => '<string>',
        'truststoreVersion' => '<string>',
        'truststoreWarnings' => ['<string>', ...],
    ],
    'ownershipVerificationCertificateArn' => '<string>',
    'policy' => '<string>',
    'regionalCertificateArn' => '<string>',
    'regionalCertificateName' => '<string>',
    'regionalDomainName' => '<string>',
    'regionalHostedZoneId' => '<string>',
    'securityPolicy' => 'TLS_1_0|TLS_1_2',
    'tags' => ['<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.

LimitExceededException:

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

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.

CreateDomainNameAccessAssociation

$result = $client->createDomainNameAccessAssociation([/* ... */]);
$promise = $client->createDomainNameAccessAssociationAsync([/* ... */]);

Creates a domain name access association resource between an access association source and a private custom domain name.

Parameter Syntax

$result = $client->createDomainNameAccessAssociation([
    'accessAssociationSource' => '<string>', // REQUIRED
    'accessAssociationSourceType' => 'VPCE', // REQUIRED
    'domainNameArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'accessAssociationSource' => '<string>',
    'accessAssociationSourceType' => 'VPCE',
    'domainNameAccessAssociationArn' => '<string>',
    'domainNameArn' => '<string>',
    'tags' => ['<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.

LimitExceededException:

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

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.

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

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.

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.

NotFoundException:

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

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.

CreateRequestValidator

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

Creates a RequestValidator of a given RestApi.

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.

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.

NotFoundException:

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

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.

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

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>,
                'tlsConfig' => [
                    'insecureSkipVerification' => true || false,
                ],
                '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([/* ... */]);

Creates a new RestApi resource.

Parameter Syntax

$result = $client->createRestApi([
    'apiKeySource' => 'HEADER|AUTHORIZER',
    'binaryMediaTypes' => ['<string>', ...],
    'cloneFrom' => '<string>',
    'description' => '<string>',
    'disableExecuteApiEndpoint' => true || false,
    '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>',
    'disableExecuteApiEndpoint' => true || false,
    'endpointConfiguration' => [
        'types' => ['<string>', ...],
        'vpcEndpointIds' => ['<string>', ...],
    ],
    'id' => '<string>',
    'minimumCompressionSize' => <integer>,
    'name' => '<string>',
    'policy' => '<string>',
    'rootResourceId' => '<string>',
    'tags' => ['<string>', ...],
    'version' => '<string>',
    'warnings' => ['<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.

LimitExceededException:

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

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.

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

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

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

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.

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.

NotFoundException:

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

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.

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

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.

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.

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.

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

Result Syntax

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

LimitExceededException:

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

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.

DeleteApiKey

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

Deletes the ApiKey resource.

Parameter Syntax

$result = $client->deleteApiKey([
    'apiKey' => '<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.

NotFoundException:

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

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.

DeleteAuthorizer

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

Deletes an existing Authorizer resource.

Parameter Syntax

$result = $client->deleteAuthorizer([
    'authorizerId' => '<string>', // REQUIRED
    'restApiId' => '<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.

NotFoundException:

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

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.

DeleteBasePathMapping

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

Deletes the BasePathMapping resource.

Parameter Syntax

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

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.

NotFoundException:

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

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.

DeleteClientCertificate

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

Deletes the ClientCertificate resource.

Parameter Syntax

$result = $client->deleteClientCertificate([
    'clientCertificateId' => '<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.

NotFoundException:

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

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.

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

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.

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.

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.

DeleteDocumentationPart

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

Deletes a documentation part

Parameter Syntax

$result = $client->deleteDocumentationPart([
    'documentationPartId' => '<string>', // REQUIRED
    'restApiId' => '<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.

NotFoundException:

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

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.

DeleteDocumentationVersion

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

Deletes a documentation version.

Parameter Syntax

$result = $client->deleteDocumentationVersion([
    'documentationVersion' => '<string>', // REQUIRED
    'restApiId' => '<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.

NotFoundException:

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

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.

DeleteDomainName

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

Deletes the DomainName resource.

Parameter Syntax

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

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.

NotFoundException:

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

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.

DeleteDomainNameAccessAssociation

$result = $client->deleteDomainNameAccessAssociation([/* ... */]);
$promise = $client->deleteDomainNameAccessAssociationAsync([/* ... */]);

Deletes the DomainNameAccessAssociation resource.

Only the AWS account that created the DomainNameAccessAssociation resource can delete it. To stop an access association source in another AWS account from accessing your private custom domain name, use the RejectDomainNameAccessAssociation operation.

Parameter Syntax

$result = $client->deleteDomainNameAccessAssociation([
    'domainNameAccessAssociationArn' => '<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.

NotFoundException:

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

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.

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|WAF_FILTERED', // REQUIRED
    'restApiId' => '<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.

NotFoundException:

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

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.

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

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.

NotFoundException:

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

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.

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

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.

NotFoundException:

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

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.

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

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

Deletes an existing MethodResponse resource.

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

Deletes a model.

Parameter Syntax

$result = $client->deleteModel([
    'modelName' => '<string>', // REQUIRED
    'restApiId' => '<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.

NotFoundException:

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

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.

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

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.

NotFoundException:

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

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.

DeleteResource

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

Deletes a Resource resource.

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

Deletes the specified API.

Parameter Syntax

$result = $client->deleteRestApi([
    'restApiId' => '<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.

NotFoundException:

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

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.

DeleteStage

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

Deletes a Stage resource.

Parameter Syntax

$result = $client->deleteStage([
    'restApiId' => '<string>', // REQUIRED
    'stageName' => '<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.

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.

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.

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

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.

NotFoundException:

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

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.

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

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.

NotFoundException:

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

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.

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

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.

NotFoundException:

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

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.

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

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.

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.

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.

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

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.

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.

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.

GenerateClientCertificate

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

Generates a ClientCertificate resource.

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

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.

LimitExceededException:

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

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.

GetAccount

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

Gets information about the current Account resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'apiKeyVersion' => '<string>',
    'cloudwatchRoleArn' => '<string>',
    'features' => ['<string>', ...],
    'throttleSettings' => [
        '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.

NotFoundException:

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

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.

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

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

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.

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.

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

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

Errors

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.

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.

Parameter Syntax

$result = $client->getAuthorizer([
    'authorizerId' => '<string>', // REQUIRED
    'restApiId' => '<string>', // 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.

NotFoundException:

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

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.

GetAuthorizers

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

Describe an existing Authorizers resource.

Parameter Syntax

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

Parameter Details

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

Errors

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.

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.

GetBasePathMapping

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

Describe a BasePathMapping resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'basePath' => '<string>',
    'restApiId' => '<string>',
    'stage' => '<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.

NotFoundException:

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

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.

GetBasePathMappings

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

Represents a collection of BasePathMapping resources.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'items' => [
        [
            'basePath' => '<string>',
            'restApiId' => '<string>',
            'stage' => '<string>',
        ],
        // ...
    ],
    'position' => '<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.

NotFoundException:

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

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.

GetClientCertificate

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

Gets information about the current ClientCertificate resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'clientCertificateId' => '<string>',
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'expirationDate' => <DateTime>,
    'pemEncodedCertificate' => '<string>',
    'tags' => ['<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.

NotFoundException:

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

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.

GetClientCertificates

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

Gets a collection of ClientCertificate resources.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'items' => [
        [
            'clientCertificateId' => '<string>',
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'expirationDate' => <DateTime>,
            'pemEncodedCertificate' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'position' => '<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.

NotFoundException:

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

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

Result Syntax

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

NotFoundException:

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

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.

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

Result Syntax

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

NotFoundException:

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

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

Gets a documentation part.

Parameter Syntax

$result = $client->getDocumentationPart([
    'documentationPartId' => '<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.

NotFoundException:

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

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.

GetDocumentationParts

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

Gets documentation parts.

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

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

Errors

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.

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.

GetDocumentationVersion

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

Gets a documentation version.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details