GetApiResponse class

Constructors

GetApiResponse({String? apiEndpoint, bool? apiGatewayManaged, String? apiId, String? apiKeySelectionExpression, Cors? corsConfiguration, DateTime? createdDate, String? description, bool? disableExecuteApiEndpoint, bool? disableSchemaValidation, List<String>? importInfo, String? name, ProtocolType? protocolType, String? routeSelectionExpression, Map<String, String>? tags, String? version, List<String>? warnings})
GetApiResponse.fromJson(Map<String, dynamic> json)
factory

Properties

apiEndpoint → String?
The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
final
apiGatewayManaged → bool?
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
final
apiId → String?
The API ID.
final
apiKeySelectionExpression → String?
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
final
corsConfiguration → Cors?
A CORS configuration. Supported only for HTTP APIs.
final
createdDate → DateTime?
The timestamp when the API was created.
final
description → String?
The description of the API.
final
disableExecuteApiEndpoint → bool?
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
final
disableSchemaValidation → bool?
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
final
hashCode → int
The hash code for this object.
no setterinherited
importInfo → List<String>?
The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
final
name → String?
The name of the API.
final
protocolType → ProtocolType?
The API protocol.
final
routeSelectionExpression → String?
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags → Map<String, String>?
A collection of tags associated with the API.
final
version → String?
A version identifier for the API.
final
warnings → List<String>?
The warning messages reported when failonwarnings is turned on during API import.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited