CreateApi

$result = $client->createApi([/* ... */]);
$promise = $client->createApiAsync([/* ... */]);

Creates an Api resource.

Parameter Syntax

$result = $client->createApi([
    'ApiKeySelectionExpression' => '<string>',
    'CorsConfiguration' => [
        'AllowCredentials' => true || false,
        'AllowHeaders' => ['<string>', ...],
        'AllowMethods' => ['<string>', ...],
        'AllowOrigins' => ['<string>', ...],
        'ExposeHeaders' => ['<string>', ...],
        'MaxAge' => <integer>,
    ],
    'CredentialsArn' => '<string>',
    'Description' => '<string>',
    'DisableExecuteApiEndpoint' => true || false,
    'DisableSchemaValidation' => true || false,
    'IpAddressType' => 'ipv4|dualstack',
    'Name' => '<string>', // REQUIRED
    'ProtocolType' => 'WEBSOCKET|HTTP', // REQUIRED
    'RouteKey' => '<string>',
    'RouteSelectionExpression' => '<string>',
    'Tags' => ['<string>', ...],
    'Target' => '<string>',
    'Version' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ApiEndpoint' => '<string>',
    'ApiGatewayManaged' => true || false,
    'ApiId' => '<string>',
    'ApiKeySelectionExpression' => '<string>',
    'CorsConfiguration' => [
        'AllowCredentials' => true || false,
        'AllowHeaders' => ['<string>', ...],
        'AllowMethods' => ['<string>', ...],
        'AllowOrigins' => ['<string>', ...],
        'ExposeHeaders' => ['<string>', ...],
        'MaxAge' => <integer>,
    ],
    'CreatedDate' => <DateTime>,
    'Description' => '<string>',
    'DisableExecuteApiEndpoint' => true || false,
    'DisableSchemaValidation' => true || false,
    'ImportInfo' => ['<string>', ...],
    'IpAddressType' => 'ipv4|dualstack',
    'Name' => '<string>',
    'ProtocolType' => 'WEBSOCKET|HTTP',
    'RouteSelectionExpression' => '<string>',
    'Tags' => ['<string>', ...],
    'Version' => '<string>',
    'Warnings' => ['<string>', ...],
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

CreateApiMapping

$result = $client->createApiMapping([/* ... */]);
$promise = $client->createApiMappingAsync([/* ... */]);

Creates an API mapping.

Parameter Syntax

$result = $client->createApiMapping([
    'ApiId' => '<string>', // REQUIRED
    'ApiMappingKey' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'Stage' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApiId' => '<string>',
    'ApiMappingId' => '<string>',
    'ApiMappingKey' => '<string>',
    'Stage' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

CreateAuthorizer

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

Creates an Authorizer for an API.

Parameter Syntax

$result = $client->createAuthorizer([
    'ApiId' => '<string>', // REQUIRED
    'AuthorizerCredentialsArn' => '<string>',
    'AuthorizerPayloadFormatVersion' => '<string>',
    'AuthorizerResultTtlInSeconds' => <integer>,
    'AuthorizerType' => 'REQUEST|JWT', // REQUIRED
    'AuthorizerUri' => '<string>',
    'EnableSimpleResponses' => true || false,
    'IdentitySource' => ['<string>', ...], // REQUIRED
    'IdentityValidationExpression' => '<string>',
    'JwtConfiguration' => [
        'Audience' => ['<string>', ...],
        'Issuer' => '<string>',
    ],
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AuthorizerCredentialsArn' => '<string>',
    'AuthorizerId' => '<string>',
    'AuthorizerPayloadFormatVersion' => '<string>',
    'AuthorizerResultTtlInSeconds' => <integer>,
    'AuthorizerType' => 'REQUEST|JWT',
    'AuthorizerUri' => '<string>',
    'EnableSimpleResponses' => true || false,
    'IdentitySource' => ['<string>', ...],
    'IdentityValidationExpression' => '<string>',
    'JwtConfiguration' => [
        'Audience' => ['<string>', ...],
        'Issuer' => '<string>',
    ],
    'Name' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

CreateDeployment

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

Creates a Deployment for an API.

Parameter Syntax

$result = $client->createDeployment([
    'ApiId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'StageName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AutoDeployed' => true || false,
    'CreatedDate' => <DateTime>,
    'DeploymentId' => '<string>',
    'DeploymentStatus' => 'PENDING|FAILED|DEPLOYED',
    'DeploymentStatusMessage' => '<string>',
    'Description' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

CreateDomainName

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

Creates a domain name.

Parameter Syntax

$result = $client->createDomainName([
    'DomainName' => '<string>', // REQUIRED
    'DomainNameConfigurations' => [
        [
            'ApiGatewayDomainName' => '<string>',
            'CertificateArn' => '<string>',
            'CertificateName' => '<string>',
            'CertificateUploadDate' => <integer || string || DateTime>,
            'DomainNameStatus' => 'AVAILABLE|UPDATING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION',
            'DomainNameStatusMessage' => '<string>',
            'EndpointType' => 'REGIONAL|EDGE',
            'HostedZoneId' => '<string>',
            'IpAddressType' => 'ipv4|dualstack',
            'OwnershipVerificationCertificateArn' => '<string>',
            'SecurityPolicy' => 'TLS_1_0|TLS_1_2',
        ],
        // ...
    ],
    'MutualTlsAuthentication' => [
        'TruststoreUri' => '<string>',
        'TruststoreVersion' => '<string>',
    ],
    'RoutingMode' => 'API_MAPPING_ONLY|ROUTING_RULE_ONLY|ROUTING_RULE_THEN_API_MAPPING',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ApiMappingSelectionExpression' => '<string>',
    'DomainName' => '<string>',
    'DomainNameArn' => '<string>',
    'DomainNameConfigurations' => [
        [
            'ApiGatewayDomainName' => '<string>',
            'CertificateArn' => '<string>',
            'CertificateName' => '<string>',
            'CertificateUploadDate' => <DateTime>,
            'DomainNameStatus' => 'AVAILABLE|UPDATING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION',
            'DomainNameStatusMessage' => '<string>',
            'EndpointType' => 'REGIONAL|EDGE',
            'HostedZoneId' => '<string>',
            'IpAddressType' => 'ipv4|dualstack',
            'OwnershipVerificationCertificateArn' => '<string>',
            'SecurityPolicy' => 'TLS_1_0|TLS_1_2',
        ],
        // ...
    ],
    'MutualTlsAuthentication' => [
        'TruststoreUri' => '<string>',
        'TruststoreVersion' => '<string>',
        'TruststoreWarnings' => ['<string>', ...],
    ],
    'RoutingMode' => 'API_MAPPING_ONLY|ROUTING_RULE_ONLY|ROUTING_RULE_THEN_API_MAPPING',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

AccessDeniedException:

This error does not currently have a description.

CreateIntegration

$result = $client->createIntegration([/* ... */]);
$promise = $client->createIntegrationAsync([/* ... */]);

Creates an Integration.

Parameter Syntax

$result = $client->createIntegration([
    'ApiId' => '<string>', // REQUIRED
    'ConnectionId' => '<string>',
    'ConnectionType' => 'INTERNET|VPC_LINK',
    'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'CredentialsArn' => '<string>',
    'Description' => '<string>',
    'IntegrationMethod' => '<string>',
    'IntegrationSubtype' => '<string>',
    'IntegrationType' => 'AWS|HTTP|MOCK|HTTP_PROXY|AWS_PROXY', // REQUIRED
    'IntegrationUri' => '<string>',
    'PassthroughBehavior' => 'WHEN_NO_MATCH|NEVER|WHEN_NO_TEMPLATES',
    'PayloadFormatVersion' => '<string>',
    'RequestParameters' => ['<string>', ...],
    'RequestTemplates' => ['<string>', ...],
    'ResponseParameters' => [
        '<__string>' => ['<string>', ...],
        // ...
    ],
    'TemplateSelectionExpression' => '<string>',
    'TimeoutInMillis' => <integer>,
    'TlsConfig' => [
        'ServerNameToVerify' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'ApiGatewayManaged' => true || false,
    'ConnectionId' => '<string>',
    'ConnectionType' => 'INTERNET|VPC_LINK',
    'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'CredentialsArn' => '<string>',
    'Description' => '<string>',
    'IntegrationId' => '<string>',
    'IntegrationMethod' => '<string>',
    'IntegrationResponseSelectionExpression' => '<string>',
    'IntegrationSubtype' => '<string>',
    'IntegrationType' => 'AWS|HTTP|MOCK|HTTP_PROXY|AWS_PROXY',
    'IntegrationUri' => '<string>',
    'PassthroughBehavior' => 'WHEN_NO_MATCH|NEVER|WHEN_NO_TEMPLATES',
    'PayloadFormatVersion' => '<string>',
    'RequestParameters' => ['<string>', ...],
    'RequestTemplates' => ['<string>', ...],
    'ResponseParameters' => [
        '<__string>' => ['<string>', ...],
        // ...
    ],
    'TemplateSelectionExpression' => '<string>',
    'TimeoutInMillis' => <integer>,
    'TlsConfig' => [
        'ServerNameToVerify' => '<string>',
    ],
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

CreateIntegrationResponse

$result = $client->createIntegrationResponse([/* ... */]);
$promise = $client->createIntegrationResponseAsync([/* ... */]);

Creates an IntegrationResponses.

Parameter Syntax

$result = $client->createIntegrationResponse([
    'ApiId' => '<string>', // REQUIRED
    'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'IntegrationId' => '<string>', // REQUIRED
    'IntegrationResponseKey' => '<string>', // REQUIRED
    'ResponseParameters' => ['<string>', ...],
    'ResponseTemplates' => ['<string>', ...],
    'TemplateSelectionExpression' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'IntegrationResponseId' => '<string>',
    'IntegrationResponseKey' => '<string>',
    'ResponseParameters' => ['<string>', ...],
    'ResponseTemplates' => ['<string>', ...],
    'TemplateSelectionExpression' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

CreateModel

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

Creates a Model for an API.

Parameter Syntax

$result = $client->createModel([
    'ApiId' => '<string>', // REQUIRED
    'ContentType' => '<string>',
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Schema' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContentType' => '<string>',
    'Description' => '<string>',
    'ModelId' => '<string>',
    'Name' => '<string>',
    'Schema' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

CreatePortal

$result = $client->createPortal([/* ... */]);
$promise = $client->createPortalAsync([/* ... */]);

Creates a portal.

Parameter Syntax

$result = $client->createPortal([
    'Authorization' => [ // REQUIRED
        'CognitoConfig' => [
            'AppClientId' => '<string>', // REQUIRED
            'UserPoolArn' => '<string>', // REQUIRED
            'UserPoolDomain' => '<string>', // REQUIRED
        ],
        'None' => [
        ],
    ],
    'EndpointConfiguration' => [ // REQUIRED
        'AcmManaged' => [
            'CertificateArn' => '<string>', // REQUIRED
            'DomainName' => '<string>', // REQUIRED
        ],
        'None' => [
        ],
    ],
    'IncludedPortalProductArns' => ['<string>', ...],
    'LogoUri' => '<string>',
    'PortalContent' => [ // REQUIRED
        'Description' => '<string>',
        'DisplayName' => '<string>', // REQUIRED
        'Theme' => [ // REQUIRED
            'CustomColors' => [ // REQUIRED
                'AccentColor' => '<string>', // REQUIRED
                'BackgroundColor' => '<string>', // REQUIRED
                'ErrorValidationColor' => '<string>', // REQUIRED
                'HeaderColor' => '<string>', // REQUIRED
                'NavigationColor' => '<string>', // REQUIRED
                'TextColor' => '<string>', // REQUIRED
            ],
            'LogoLastUploaded' => <integer || string || DateTime>,
        ],
    ],
    'RumAppMonitorName' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Authorization' => [
        'CognitoConfig' => [
            'AppClientId' => '<string>',
            'UserPoolArn' => '<string>',
            'UserPoolDomain' => '<string>',
        ],
        'None' => [
        ],
    ],
    'EndpointConfiguration' => [
        'CertificateArn' => '<string>',
        'DomainName' => '<string>',
        'PortalDefaultDomainName' => '<string>',
        'PortalDomainHostedZoneId' => '<string>',
    ],
    'IncludedPortalProductArns' => ['<string>', ...],
    'LastModified' => <DateTime>,
    'LastPublished' => <DateTime>,
    'LastPublishedDescription' => '<string>',
    'PortalArn' => '<string>',
    'PortalContent' => [
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'Theme' => [
            'CustomColors' => [
                'AccentColor' => '<string>',
                'BackgroundColor' => '<string>',
                'ErrorValidationColor' => '<string>',
                'HeaderColor' => '<string>',
                'NavigationColor' => '<string>',
                'TextColor' => '<string>',
            ],
            'LogoLastUploaded' => <DateTime>,
        ],
    ],
    'PortalId' => '<string>',
    'PublishStatus' => 'PUBLISHED|PUBLISH_IN_PROGRESS|PUBLISH_FAILED|DISABLED',
    'RumAppMonitorName' => '<string>',
    'StatusException' => [
        'Exception' => '<string>',
        'Message' => '<string>',
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Errors

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

AccessDeniedException:

This error does not currently have a description.

CreatePortalProduct

$result = $client->createPortalProduct([/* ... */]);
$promise = $client->createPortalProductAsync([/* ... */]);

Creates a new portal product.

Parameter Syntax

$result = $client->createPortalProduct([
    'Description' => '<string>',
    'DisplayName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'DisplayOrder' => [
        'Contents' => [
            [
                'ProductRestEndpointPageArns' => ['<string>', ...],
                'SectionName' => '<string>',
            ],
            // ...
        ],
        'OverviewPageArn' => '<string>',
        'ProductPageArns' => ['<string>', ...],
    ],
    'LastModified' => <DateTime>,
    'PortalProductArn' => '<string>',
    'PortalProductId' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

AccessDeniedException:

This error does not currently have a description.

CreateProductPage

$result = $client->createProductPage([/* ... */]);
$promise = $client->createProductPageAsync([/* ... */]);

Creates a new product page for a portal product.

Parameter Syntax

$result = $client->createProductPage([
    'DisplayContent' => [ // REQUIRED
        'Body' => '<string>', // REQUIRED
        'Title' => '<string>', // REQUIRED
    ],
    'PortalProductId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DisplayContent' => [
        'Body' => '<string>',
        'Title' => '<string>',
    ],
    'LastModified' => <DateTime>,
    'ProductPageArn' => '<string>',
    'ProductPageId' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

AccessDeniedException:

This error does not currently have a description.

CreateProductRestEndpointPage

$result = $client->createProductRestEndpointPage([/* ... */]);
$promise = $client->createProductRestEndpointPageAsync([/* ... */]);

Creates a product REST endpoint page for a portal product.

Parameter Syntax

$result = $client->createProductRestEndpointPage([
    'DisplayContent' => [
        'None' => [
        ],
        'Overrides' => [
            'Body' => '<string>',
            'Endpoint' => '<string>',
            'OperationName' => '<string>',
        ],
    ],
    'PortalProductId' => '<string>', // REQUIRED
    'RestEndpointIdentifier' => [ // REQUIRED
        'IdentifierParts' => [
            'Method' => '<string>', // REQUIRED
            'Path' => '<string>', // REQUIRED
            'RestApiId' => '<string>', // REQUIRED
            'Stage' => '<string>', // REQUIRED
        ],
    ],
    'TryItState' => 'ENABLED|DISABLED',
]);

Parameter Details

Result Syntax

[
    'DisplayContent' => [
        'Body' => '<string>',
        'Endpoint' => '<string>',
        'OperationName' => '<string>',
    ],
    'LastModified' => <DateTime>,
    'ProductRestEndpointPageArn' => '<string>',
    'ProductRestEndpointPageId' => '<string>',
    'RestEndpointIdentifier' => [
        'IdentifierParts' => [
            'Method' => '<string>',
            'Path' => '<string>',
            'RestApiId' => '<string>',
            'Stage' => '<string>',
        ],
    ],
    'Status' => 'AVAILABLE|IN_PROGRESS|FAILED',
    'StatusException' => [
        'Exception' => '<string>',
        'Message' => '<string>',
    ],
    'TryItState' => 'ENABLED|DISABLED',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

AccessDeniedException:

This error does not currently have a description.

CreateRoute

$result = $client->createRoute([/* ... */]);
$promise = $client->createRouteAsync([/* ... */]);

Creates a Route for an API.

Parameter Syntax

$result = $client->createRoute([
    'ApiId' => '<string>', // REQUIRED
    'ApiKeyRequired' => true || false,
    'AuthorizationScopes' => ['<string>', ...],
    'AuthorizationType' => 'NONE|AWS_IAM|CUSTOM|JWT',
    'AuthorizerId' => '<string>',
    'ModelSelectionExpression' => '<string>',
    'OperationName' => '<string>',
    'RequestModels' => ['<string>', ...],
    'RequestParameters' => [
        '<__string>' => [
            'Required' => true || false,
        ],
        // ...
    ],
    'RouteKey' => '<string>', // REQUIRED
    'RouteResponseSelectionExpression' => '<string>',
    'Target' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ApiGatewayManaged' => true || false,
    'ApiKeyRequired' => true || false,
    'AuthorizationScopes' => ['<string>', ...],
    'AuthorizationType' => 'NONE|AWS_IAM|CUSTOM|JWT',
    'AuthorizerId' => '<string>',
    'ModelSelectionExpression' => '<string>',
    'OperationName' => '<string>',
    'RequestModels' => ['<string>', ...],
    'RequestParameters' => [
        '<__string>' => [
            'Required' => true || false,
        ],
        // ...
    ],
    'RouteId' => '<string>',
    'RouteKey' => '<string>',
    'RouteResponseSelectionExpression' => '<string>',
    'Target' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

CreateRouteResponse

$result = $client->createRouteResponse([/* ... */]);
$promise = $client->createRouteResponseAsync([/* ... */]);

Creates a RouteResponse for a Route.

Parameter Syntax

$result = $client->createRouteResponse([
    'ApiId' => '<string>', // REQUIRED
    'ModelSelectionExpression' => '<string>',
    'ResponseModels' => ['<string>', ...],
    'ResponseParameters' => [
        '<__string>' => [
            'Required' => true || false,
        ],
        // ...
    ],
    'RouteId' => '<string>', // REQUIRED
    'RouteResponseKey' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ModelSelectionExpression' => '<string>',
    'ResponseModels' => ['<string>', ...],
    'ResponseParameters' => [
        '<__string>' => [
            'Required' => true || false,
        ],
        // ...
    ],
    'RouteResponseId' => '<string>',
    'RouteResponseKey' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

CreateRoutingRule

$result = $client->createRoutingRule([/* ... */]);
$promise = $client->createRoutingRuleAsync([/* ... */]);

Create a routing rule.

Parameter Syntax

$result = $client->createRoutingRule([
    'Actions' => [ // REQUIRED
        [
            'InvokeApi' => [ // REQUIRED
                'ApiId' => '<string>', // REQUIRED
                'Stage' => '<string>', // REQUIRED
                'StripBasePath' => true || false,
            ],
        ],
        // ...
    ],
    'Conditions' => [ // REQUIRED
        [
            'MatchBasePaths' => [
                'AnyOf' => ['<string>', ...], // REQUIRED
            ],
            'MatchHeaders' => [
                'AnyOf' => [ // REQUIRED
                    [
                        'Header' => '<string>', // REQUIRED
                        'ValueGlob' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'DomainName' => '<string>', // REQUIRED
    'DomainNameId' => '<string>',
    'Priority' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Actions' => [
        [
            'InvokeApi' => [
                'ApiId' => '<string>',
                'Stage' => '<string>',
                'StripBasePath' => true || false,
            ],
        ],
        // ...
    ],
    'Conditions' => [
        [
            'MatchBasePaths' => [
                'AnyOf' => ['<string>', ...],
            ],
            'MatchHeaders' => [
                'AnyOf' => [
                    [
                        'Header' => '<string>',
                        'ValueGlob' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'Priority' => <integer>,
    'RoutingRuleArn' => '<string>',
    'RoutingRuleId' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

CreateStage

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

Creates a Stage for an API.

Parameter Syntax

$result = $client->createStage([
    'AccessLogSettings' => [
        'DestinationArn' => '<string>',
        'Format' => '<string>',
    ],
    'ApiId' => '<string>', // REQUIRED
    'AutoDeploy' => true || false,
    'ClientCertificateId' => '<string>',
    'DefaultRouteSettings' => [
        'DataTraceEnabled' => true || false,
        'DetailedMetricsEnabled' => true || false,
        'LoggingLevel' => 'ERROR|INFO|OFF',
        'ThrottlingBurstLimit' => <integer>,
        'ThrottlingRateLimit' => <float>,
    ],
    'DeploymentId' => '<string>',
    'Description' => '<string>',
    'RouteSettings' => [
        '<__string>' => [
            'DataTraceEnabled' => true || false,
            'DetailedMetricsEnabled' => true || false,
            'LoggingLevel' => 'ERROR|INFO|OFF',
            'ThrottlingBurstLimit' => <integer>,
            'ThrottlingRateLimit' => <float>,
        ],
        // ...
    ],
    'StageName' => '<string>', // REQUIRED
    'StageVariables' => ['<string>', ...],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'AccessLogSettings' => [
        'DestinationArn' => '<string>',
        'Format' => '<string>',
    ],
    'ApiGatewayManaged' => true || false,
    'AutoDeploy' => true || false,
    'ClientCertificateId' => '<string>',
    'CreatedDate' => <DateTime>,
    'DefaultRouteSettings' => [
        'DataTraceEnabled' => true || false,
        'DetailedMetricsEnabled' => true || false,
        'LoggingLevel' => 'ERROR|INFO|OFF',
        'ThrottlingBurstLimit' => <integer>,
        'ThrottlingRateLimit' => <float>,
    ],
    'DeploymentId' => '<string>',
    'Description' => '<string>',
    'LastDeploymentStatusMessage' => '<string>',
    'LastUpdatedDate' => <DateTime>,
    'RouteSettings' => [
        '<__string>' => [
            'DataTraceEnabled' => true || false,
            'DetailedMetricsEnabled' => true || false,
            'LoggingLevel' => 'ERROR|INFO|OFF',
            'ThrottlingBurstLimit' => <integer>,
            'ThrottlingRateLimit' => <float>,
        ],
        // ...
    ],
    'StageName' => '<string>',
    'StageVariables' => ['<string>', ...],
    'Tags' => ['<string>', ...],
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

CreateVpcLink

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

Creates a VPC link.

Parameter Syntax

$result = $client->createVpcLink([
    'Name' => '<string>', // REQUIRED
    'SecurityGroupIds' => ['<string>', ...],
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'CreatedDate' => <DateTime>,
    'Name' => '<string>',
    'SecurityGroupIds' => ['<string>', ...],
    'SubnetIds' => ['<string>', ...],
    'Tags' => ['<string>', ...],
    'VpcLinkId' => '<string>',
    'VpcLinkStatus' => 'PENDING|AVAILABLE|DELETING|FAILED|INACTIVE',
    'VpcLinkStatusMessage' => '<string>',
    'VpcLinkVersion' => 'V2',
]

Result Details

Errors

BadRequestException:

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

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteAccessLogSettings

$result = $client->deleteAccessLogSettings([/* ... */]);
$promise = $client->deleteAccessLogSettingsAsync([/* ... */]);

Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.

Parameter Syntax

$result = $client->deleteAccessLogSettings([
    'ApiId' => '<string>', // REQUIRED
    'StageName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteApi

$result = $client->deleteApi([/* ... */]);
$promise = $client->deleteApiAsync([/* ... */]);

Deletes an Api resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteApiMapping

$result = $client->deleteApiMapping([/* ... */]);
$promise = $client->deleteApiMappingAsync([/* ... */]);

Deletes an API mapping.

Parameter Syntax

$result = $client->deleteApiMapping([
    'ApiMappingId' => '<string>', // REQUIRED
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

DeleteAuthorizer

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

Deletes an Authorizer.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteCorsConfiguration

$result = $client->deleteCorsConfiguration([/* ... */]);
$promise = $client->deleteCorsConfigurationAsync([/* ... */]);

Deletes a CORS configuration.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteDeployment

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

Deletes a Deployment.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteDomainName

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

Deletes a domain name.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteIntegration

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

Deletes an Integration.

Parameter Syntax

$result = $client->deleteIntegration([
    'ApiId' => '<string>', // REQUIRED
    'IntegrationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteIntegrationResponse

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

Deletes an IntegrationResponses.

Parameter Syntax

$result = $client->deleteIntegrationResponse([
    'ApiId' => '<string>', // REQUIRED
    'IntegrationId' => '<string>', // REQUIRED
    'IntegrationResponseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteModel

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

Deletes a Model.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeletePortal

$result = $client->deletePortal([/* ... */]);
$promise = $client->deletePortalAsync([/* ... */]);

Deletes a portal.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

AccessDeniedException:

This error does not currently have a description.

DeletePortalProduct

$result = $client->deletePortalProduct([/* ... */]);
$promise = $client->deletePortalProductAsync([/* ... */]);

Deletes a portal product.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

AccessDeniedException:

This error does not currently have a description.

DeletePortalProductSharingPolicy

$result = $client->deletePortalProductSharingPolicy([/* ... */]);
$promise = $client->deletePortalProductSharingPolicyAsync([/* ... */]);

Deletes the sharing policy for a portal product.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

AccessDeniedException:

This error does not currently have a description.

DeleteProductPage

$result = $client->deleteProductPage([/* ... */]);
$promise = $client->deleteProductPageAsync([/* ... */]);

Deletes a product page of a portal product.

Parameter Syntax

$result = $client->deleteProductPage([
    'PortalProductId' => '<string>', // REQUIRED
    'ProductPageId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

AccessDeniedException:

This error does not currently have a description.

DeleteProductRestEndpointPage

$result = $client->deleteProductRestEndpointPage([/* ... */]);
$promise = $client->deleteProductRestEndpointPageAsync([/* ... */]);

Deletes a product REST endpoint page.

Parameter Syntax

$result = $client->deleteProductRestEndpointPage([
    'PortalProductId' => '<string>', // REQUIRED
    'ProductRestEndpointPageId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

AccessDeniedException:

This error does not currently have a description.

DeleteRoute

$result = $client->deleteRoute([/* ... */]);
$promise = $client->deleteRouteAsync([/* ... */]);

Deletes a Route.

Parameter Syntax

$result = $client->deleteRoute([
    'ApiId' => '<string>', // REQUIRED
    'RouteId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteRouteRequestParameter

$result = $client->deleteRouteRequestParameter([/* ... */]);
$promise = $client->deleteRouteRequestParameterAsync([/* ... */]);

Deletes a route request parameter. Supported only for WebSocket APIs.

Parameter Syntax

$result = $client->deleteRouteRequestParameter([
    'ApiId' => '<string>', // REQUIRED
    'RequestParameterKey' => '<string>', // REQUIRED
    'RouteId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteRouteResponse

$result = $client->deleteRouteResponse([/* ... */]);
$promise = $client->deleteRouteResponseAsync([/* ... */]);

Deletes a RouteResponse.

Parameter Syntax

$result = $client->deleteRouteResponse([
    'ApiId' => '<string>', // REQUIRED
    'RouteId' => '<string>', // REQUIRED
    'RouteResponseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteRouteSettings

$result = $client->deleteRouteSettings([/* ... */]);
$promise = $client->deleteRouteSettingsAsync([/* ... */]);

Deletes the RouteSettings for a stage.

Parameter Syntax

$result = $client->deleteRouteSettings([
    'ApiId' => '<string>', // REQUIRED
    'RouteKey' => '<string>', // REQUIRED
    'StageName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteRoutingRule

$result = $client->deleteRoutingRule([/* ... */]);
$promise = $client->deleteRoutingRuleAsync([/* ... */]);

Deletes a routing rule.

Parameter Syntax

$result = $client->deleteRoutingRule([
    'DomainName' => '<string>', // REQUIRED
    'DomainNameId' => '<string>',
    'RoutingRuleId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

DeleteStage

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

Deletes a Stage.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DeleteVpcLink

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

Deletes a VPC link.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

DisablePortal

$result = $client->disablePortal([/* ... */]);
$promise = $client->disablePortalAsync([/* ... */]);

Deletes the publication of a portal portal.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

AccessDeniedException:

This error does not currently have a description.

ExportApi

$result = $client->exportApi([/* ... */]);
$promise = $client->exportApiAsync([/* ... */]);

Exports a definition of an API in a particular output format and specification.

Parameter Syntax

$result = $client->exportApi([
    'ApiId' => '<string>', // REQUIRED
    'ExportVersion' => '<string>',
    'IncludeExtensions' => true || false,
    'OutputType' => 'YAML|JSON', // REQUIRED
    'Specification' => 'OAS30', // REQUIRED
    'StageName' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

GetApiMapping

$result = $client->getApiMapping([/* ... */]);
$promise = $client->getApiMappingAsync([/* ... */]);

Gets an API mapping.

Parameter Syntax

$result = $client->getApiMapping([
    'ApiMappingId' => '<string>', // REQUIRED
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApiId' => '<string>',
    'ApiMappingId' => '<string>',
    'ApiMappingKey' => '<string>',
    'Stage' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

GetApiMappings

$result = $client->getApiMappings([/* ... */]);
$promise = $client->getApiMappingsAsync([/* ... */]);

Gets API mappings.

Parameter Syntax

$result = $client->getApiMappings([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'ApiId' => '<string>',
            'ApiMappingId' => '<string>',
            'ApiMappingKey' => '<string>',
            'Stage' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

GetApiResource

$result = $client->getApiResource([/* ... */]);
$promise = $client->getApiResourceAsync([/* ... */]);

Gets an Api resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ApiEndpoint' => '<string>',
    'ApiGatewayManaged' => true || false,
    'ApiId' => '<string>',
    'ApiKeySelectionExpression' => '<string>',
    'CorsConfiguration' => [
        'AllowCredentials' => true || false,
        'AllowHeaders' => ['<string>', ...],
        'AllowMethods' => ['<string>', ...],
        'AllowOrigins' => ['<string>', ...],
        'ExposeHeaders' => ['<string>', ...],
        'MaxAge' => <integer>,
    ],
    'CreatedDate' => <DateTime>,
    'Description' => '<string>',
    'DisableExecuteApiEndpoint' => true || false,
    'DisableSchemaValidation' => true || false,
    'ImportInfo' => ['<string>', ...],
    'IpAddressType' => 'ipv4|dualstack',
    'Name' => '<string>',
    'ProtocolType' => 'WEBSOCKET|HTTP',
    'RouteSelectionExpression' => '<string>',
    'Tags' => ['<string>', ...],
    'Version' => '<string>',
    'Warnings' => ['<string>', ...],
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

GetApis

$result = $client->getApis([/* ... */]);
$promise = $client->getApisAsync([/* ... */]);

Gets a collection of Api resources.

Parameter Syntax

$result = $client->getApis([
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'ApiEndpoint' => '<string>',
            'ApiGatewayManaged' => true || false,
            'ApiId' => '<string>',
            'ApiKeySelectionExpression' => '<string>',
            'CorsConfiguration' => [
                'AllowCredentials' => true || false,
                'AllowHeaders' => ['<string>', ...],
                'AllowMethods' => ['<string>', ...],
                'AllowOrigins' => ['<string>', ...],
                'ExposeHeaders' => ['<string>', ...],
                'MaxAge' => <integer>,
            ],
            'CreatedDate' => <DateTime>,
            'Description' => '<string>',
            'DisableExecuteApiEndpoint' => true || false,
            'DisableSchemaValidation' => true || false,
            'ImportInfo' => ['<string>', ...],
            'IpAddressType' => 'ipv4|dualstack',
            'Name' => '<string>',
            'ProtocolType' => 'WEBSOCKET|HTTP',
            'RouteSelectionExpression' => '<string>',
            'Tags' => ['<string>', ...],
            'Version' => '<string>',
            'Warnings' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

GetAuthorizer

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

Gets an Authorizer.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AuthorizerCredentialsArn' => '<string>',
    'AuthorizerId' => '<string>',
    'AuthorizerPayloadFormatVersion' => '<string>',
    'AuthorizerResultTtlInSeconds' => <integer>,
    'AuthorizerType' => 'REQUEST|JWT',
    'AuthorizerUri' => '<string>',
    'EnableSimpleResponses' => true || false,
    'IdentitySource' => ['<string>', ...],
    'IdentityValidationExpression' => '<string>',
    'JwtConfiguration' => [
        'Audience' => ['<string>', ...],
        'Issuer' => '<string>',
    ],
    'Name' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

GetAuthorizers

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

Gets the Authorizers for an API.

Parameter Syntax

$result = $client->getAuthorizers([
    'ApiId' => '<string>', // REQUIRED
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'AuthorizerCredentialsArn' => '<string>',
            'AuthorizerId' => '<string>',
            'AuthorizerPayloadFormatVersion' => '<string>',
            'AuthorizerResultTtlInSeconds' => <integer>,
            'AuthorizerType' => 'REQUEST|JWT',
            'AuthorizerUri' => '<string>',
            'EnableSimpleResponses' => true || false,
            'IdentitySource' => ['<string>', ...],
            'IdentityValidationExpression' => '<string>',
            'JwtConfiguration' => [
                'Audience' => ['<string>', ...],
                'Issuer' => '<string>',
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

GetDeployment

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

Gets a Deployment.

Parameter Syntax

$result = $client->getDeployment([
    'ApiId' => '<string>', // REQUIRED
    'DeploymentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AutoDeployed' => true || false,
    'CreatedDate' => <DateTime>,
    'DeploymentId' => '<string>',
    'DeploymentStatus' => 'PENDING|FAILED|DEPLOYED',
    'DeploymentStatusMessage' => '<string>',
    'Description' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

GetDeployments

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

Gets the Deployments for an API.

Parameter Syntax

$result = $client->getDeployments([
    'ApiId' => '<string>', // REQUIRED
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'AutoDeployed' => true || false,
            'CreatedDate' => <DateTime>,
            'DeploymentId' => '<string>',
            'DeploymentStatus' => 'PENDING|FAILED|DEPLOYED',
            'DeploymentStatusMessage' => '<string>',
            'Description' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

GetDomainName

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

Gets a domain name.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ApiMappingSelectionExpression' => '<string>',
    'DomainName' => '<string>',
    'DomainNameArn' => '<string>',
    'DomainNameConfigurations' => [
        [
            'ApiGatewayDomainName' => '<string>',
            'CertificateArn' => '<string>',
            'CertificateName' => '<string>',
            'CertificateUploadDate' => <DateTime>,
            'DomainNameStatus' => 'AVAILABLE|UPDATING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION',
            'DomainNameStatusMessage' => '<string>',
            'EndpointType' => 'REGIONAL|EDGE',
            'HostedZoneId' => '<string>',
            'IpAddressType' => 'ipv4|dualstack',
            'OwnershipVerificationCertificateArn' => '<string>',
            'SecurityPolicy' => 'TLS_1_0|TLS_1_2',
        ],
        // ...
    ],
    'MutualTlsAuthentication' => [
        'TruststoreUri' => '<string>',
        'TruststoreVersion' => '<string>',
        'TruststoreWarnings' => ['<string>', ...],
    ],
    'RoutingMode' => 'API_MAPPING_ONLY|ROUTING_RULE_ONLY|ROUTING_RULE_THEN_API_MAPPING',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

GetDomainNames

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

Gets the domain names for an Amazon Web Services account.

Parameter Syntax

$result = $client->getDomainNames([
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'ApiMappingSelectionExpression' => '<string>',
            'DomainName' => '<string>',
            'DomainNameArn' => '<string>',
            'DomainNameConfigurations' => [
                [
                    'ApiGatewayDomainName' => '<string>',
                    'CertificateArn' => '<string>',
                    'CertificateName' => '<string>',
                    'CertificateUploadDate' => <DateTime>,
                    'DomainNameStatus' => 'AVAILABLE|UPDATING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION',
                    'DomainNameStatusMessage' => '<string>',
                    'EndpointType' => 'REGIONAL|EDGE',
                    'HostedZoneId' => '<string>',
                    'IpAddressType' => 'ipv4|dualstack',
                    'OwnershipVerificationCertificateArn' => '<string>',
                    'SecurityPolicy' => 'TLS_1_0|TLS_1_2',
                ],
                // ...
            ],
            'MutualTlsAuthentication' => [
                'TruststoreUri' => '<string>',
                'TruststoreVersion' => '<string>',
                'TruststoreWarnings' => ['<string>', ...],
            ],
            'RoutingMode' => 'API_MAPPING_ONLY|ROUTING_RULE_ONLY|ROUTING_RULE_THEN_API_MAPPING',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

GetIntegration

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

Gets an Integration.

Parameter Syntax

$result = $client->getIntegration([
    'ApiId' => '<string>', // REQUIRED
    'IntegrationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApiGatewayManaged' => true || false,
    'ConnectionId' => '<string>',
    'ConnectionType' => 'INTERNET|VPC_LINK',
    'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'CredentialsArn' => '<string>',
    'Description' => '<string>',
    'IntegrationId' => '<string>',
    'IntegrationMethod' => '<string>',
    'IntegrationResponseSelectionExpression' => '<string>',
    'IntegrationSubtype' => '<string>',
    'IntegrationType' => 'AWS|HTTP|MOCK|HTTP_PROXY|AWS_PROXY',
    'IntegrationUri' => '<string>',
    'PassthroughBehavior' => 'WHEN_NO_MATCH|NEVER|WHEN_NO_TEMPLATES',
    'PayloadFormatVersion' => '<string>',
    'RequestParameters' => ['<string>', ...],
    'RequestTemplates' => ['<string>', ...],
    'ResponseParameters' => [
        '<__string>' => ['<string>', ...],
        // ...
    ],
    'TemplateSelectionExpression' => '<string>',
    'TimeoutInMillis' => <integer>,
    'TlsConfig' => [
        'ServerNameToVerify' => '<string>',
    ],
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

GetIntegrationResponse

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

Gets an IntegrationResponses.

Parameter Syntax

$result = $client->getIntegrationResponse([
    'ApiId' => '<string>', // REQUIRED
    'IntegrationId' => '<string>', // REQUIRED
    'IntegrationResponseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
    'IntegrationResponseId' => '<string>',
    'IntegrationResponseKey' => '<string>',
    'ResponseParameters' => ['<string>', ...],
    'ResponseTemplates' => ['<string>', ...],
    'TemplateSelectionExpression' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

GetIntegrationResponses

$result = $client->getIntegrationResponses([/* ... */]);
$promise = $client->getIntegrationResponsesAsync([/* ... */]);

Gets the IntegrationResponses for an Integration.

Parameter Syntax

$result = $client->getIntegrationResponses([
    'ApiId' => '<string>', // REQUIRED
    'IntegrationId' => '<string>', // REQUIRED
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
            'IntegrationResponseId' => '<string>',
            'IntegrationResponseKey' => '<string>',
            'ResponseParameters' => ['<string>', ...],
            'ResponseTemplates' => ['<string>', ...],
            'TemplateSelectionExpression' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

GetIntegrations

$result = $client->getIntegrations([/* ... */]);
$promise = $client->getIntegrationsAsync([/* ... */]);

Gets the Integrations for an API.

Parameter Syntax

$result = $client->getIntegrations([
    'ApiId' => '<string>', // REQUIRED
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'ApiGatewayManaged' => true || false,
            'ConnectionId' => '<string>',
            'ConnectionType' => 'INTERNET|VPC_LINK',
            'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
            'CredentialsArn' => '<string>',
            'Description' => '<string>',
            'IntegrationId' => '<string>',
            'IntegrationMethod' => '<string>',
            'IntegrationResponseSelectionExpression' => '<string>',
            'IntegrationSubtype' => '<string>',
            'IntegrationType' => 'AWS|HTTP|MOCK|HTTP_PROXY|AWS_PROXY',
            'IntegrationUri' => '<string>',
            'PassthroughBehavior' => 'WHEN_NO_MATCH|NEVER|WHEN_NO_TEMPLATES',
            'PayloadFormatVersion' => '<string>',
            'RequestParameters' => ['<string>', ...],
            'RequestTemplates' => ['<string>', ...],
            'ResponseParameters' => [
                '<__string>' => ['<string>', ...],
                // ...
            ],
            'TemplateSelectionExpression' => '<string>',
            'TimeoutInMillis' => <integer>,
            'TlsConfig' => [
                'ServerNameToVerify' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

BadRequestException:

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

GetModel

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

Gets a Model.

Parameter Syntax

$result = $client->getModel([
    'ApiId' => '<string>', // REQUIRED
    'ModelId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContentType' => '<string>',
    'Description' => '<string>',
    'ModelId' => '<string>',
    'Name' => '<string>',
    'Schema' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. See the message field for more information.

TooManyRequestsException:

A limit has been exceeded. See the accompanying error message for details.

GetModelTemplate

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

Gets a model template.

Parameter Syntax

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

Parameter Details