AWSSDK.ApiGatewayV2

Configuration for accessing Amazon ApiGatewayV2 service

Default constructor

The constant used to lookup in the region hash the endpoint.

Gets the ServiceVersion property.

Gets the value of UserAgent property.

Common exception for the ApiGatewayV2 service.

Construct instance of AmazonApiGatewayV2Exception

Constructs a new instance of the AmazonApiGatewayV2Exception class with serialized data.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0).

Service metadata for Amazon ApiGatewayV2 service

Gets the value of the Service Id.

Gets the dictionary that gives mapping of renamed operations

Settings for logging access in a stage.

Gets and sets the property DestinationArn. The ARN of the CloudWatch Logs log group to receive access logs.

Gets and sets the property Format. A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

Represents an API.

Gets and sets the property ApiEndpoint. 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.

Gets and sets the property ApiId. The API ID.

Gets and sets the property ApiKeySelectionExpression. An API key selection expression. See API Key Selection Expressions.

Gets and sets the property CreatedDate. The timestamp when the API was created.

Gets and sets the property Description. The description of the API.

Gets and sets the property DisableSchemaValidation. Avoid validating models when creating a deployment.

Gets and sets the property Name. The name of the API.

Gets and sets the property ProtocolType. The API protocol: Currently only WEBSOCKET is supported.

Gets and sets the property RouteSelectionExpression. The route selection expression for the API.

Gets and sets the property Version. A version identifier for the API.

Gets and sets the property Warnings. The warning messages reported when failonwarnings is turned on during API import.

Represents an API mapping.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property ApiMappingId. The API mapping identifier.

Gets and sets the property ApiMappingKey. The API mapping key.

Gets and sets the property Stage. The API stage.

Represents an authorizer.

Gets and sets the property AuthorizerCredentialsArn. Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Gets and sets the property AuthorizerId. The authorizer identifier.

Gets and sets the property AuthorizerResultTtlInSeconds. The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Gets and sets the property AuthorizerType. The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Gets and sets the property AuthorizerUri. The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Gets and sets the property IdentitySource. The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Gets and sets the property IdentityValidationExpression. The validation expression does not apply to the REQUEST authorizer.

Gets and sets the property Name. The name of the authorizer.

Gets and sets the property ProviderArns. For REQUEST authorizer, this is not defined.

ApiGatewayV2 exception

Constructs a new BadRequestException with the specified error message.

Describes the error encountered.

Construct instance of BadRequestException

Constructs a new instance of the BadRequestException class with serialized data.

ApiGatewayV2 exception

Constructs a new ConflictException with the specified error message.

Describes the error encountered.

Construct instance of ConflictException

Constructs a new instance of the ConflictException class with serialized data.

Container for the parameters to the CreateApiMapping operation. Creates an API mapping.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property ApiMappingKey.

Gets and sets the property DomainName. The domain name.

Gets and sets the property Stage. The API stage.

This is the response object from the CreateApiMapping operation.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property ApiMappingId. The API mapping identifier.

Gets and sets the property ApiMappingKey. The API mapping key.

Gets and sets the property Stage. The API stage.

Container for the parameters to the CreateApi operation. Creates an Api resource.

Gets and sets the property ApiKeySelectionExpression. An API key selection expression. See API Key Selection Expressions.

Gets and sets the property Description. The description of the API.

Gets and sets the property DisableSchemaValidation. Avoid validating models when creating a deployment.

Gets and sets the property Name. The name of the API.

Gets and sets the property ProtocolType. The API protocol: Currently only WEBSOCKET is supported.

Gets and sets the property RouteSelectionExpression. The route selection expression for the API.

Gets and sets the property Version. A version identifier for the API.

This is the response object from the CreateApi operation.

Gets and sets the property ApiId. The API ID.

Gets and sets the property ApiKeySelectionExpression. An API key selection expression. See API Key Selection Expressions.

Gets and sets the property CreatedDate. The timestamp when the API was created.

Gets and sets the property Description. The description of the API.

Gets and sets the property DisableSchemaValidation. Avoid validating models when creating a deployment.

Gets and sets the property Name. The name of the API.

Gets and sets the property ProtocolType. The API protocol: Currently only WEBSOCKET is supported.

Gets and sets the property RouteSelectionExpression. The route selection expression for the API.

Gets and sets the property Version. A version identifier for the API.

Gets and sets the property Warnings. The warning messages reported when failonwarnings is turned on during API import.

Container for the parameters to the CreateAuthorizer operation. Creates an Authorizer for an API.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property AuthorizerType. The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Gets and sets the property AuthorizerUri. The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Gets and sets the property IdentityValidationExpression. The validation expression does not apply to the REQUEST authorizer.

Gets and sets the property Name. The name of the authorizer.

Gets and sets the property ProviderArns. For REQUEST authorizer, this is not defined.

This is the response object from the CreateAuthorizer operation.

Gets and sets the property AuthorizerId. The authorizer identifier.

Gets and sets the property AuthorizerType. The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Gets and sets the property IdentityValidationExpression. The validation expression does not apply to the REQUEST authorizer.

Gets and sets the property Name. The name of the authorizer.

Gets and sets the property ProviderArns. For REQUEST authorizer, this is not defined.

Container for the parameters to the CreateDeployment operation. Creates a Deployment for an API.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property Description. The description for the deployment resource.

Gets and sets the property StageName. The name of the Stage resource for the Deployment resource to create.

This is the response object from the CreateDeployment operation.

Gets and sets the property CreatedDate. The date and time when the Deployment resource was created.

Gets and sets the property DeploymentId. The identifier for the deployment.

Gets and sets the property DeploymentStatus. The status of the deployment: PENDING, FAILED, or SUCCEEDED.

Gets and sets the property DeploymentStatusMessage. May contain additional feedback on the status of an API deployment.

Gets and sets the property Description. The description for the deployment.

Container for the parameters to the CreateDomainName operation. Creates a domain name.

Gets and sets the property DomainName. The domain name.

Gets and sets the property DomainNameConfigurations. The domain name configurations.

This is the response object from the CreateDomainName operation.

Gets and sets the property ApiMappingSelectionExpression. The API mapping selection expression.

Gets and sets the property DomainName. The name of the DomainName resource.

Gets and sets the property DomainNameConfigurations. The domain name configurations.

Container for the parameters to the CreateIntegration operation. Creates an Integration.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property ConnectionId. The connection ID.

Gets and sets the property ConnectionType. The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.

Gets and sets the property ContentHandlingStrategy. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Gets and sets the property CredentialsArn. Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

Gets and sets the property Description. The description of the integration.

Gets and sets the property IntegrationMethod. Specifies the integration's HTTP method type.

Gets and sets the property IntegrationType. The integration type of an integration. One of the following: AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration. HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as HTTP custom integration. HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

Gets and sets the property IntegrationUri. For a Lambda proxy integration, this is the URI of the Lambda function.

Gets and sets the property PassthroughBehavior. Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation. NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response. WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

Gets and sets the property RequestParameters. A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.

Gets and sets the property RequestTemplates. Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Gets and sets the property TemplateSelectionExpression. The template selection expression for the integration.

Gets and sets the property TimeoutInMillis. Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

This is the response object from the CreateIntegration operation.

Gets and sets the property ConnectionId. The connection ID.

Gets and sets the property Description. Represents the description of an integration.

Gets and sets the property IntegrationId. Represents the identifier of an integration.

Gets and sets the property IntegrationMethod. Specifies the integration's HTTP method type.

Gets and sets the property IntegrationResponseSelectionExpression. The integration response selection expression for the integration. See Integration Response Selection Expressions.

Gets and sets the property IntegrationType. The integration type of an integration. One of the following: AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration. HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

Gets and sets the property IntegrationUri. For a Lambda proxy integration, this is the URI of the Lambda function.

Gets and sets the property TemplateSelectionExpression. The template selection expression for the integration.

Gets and sets the property TimeoutInMillis. Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Container for the parameters to the CreateIntegrationResponse operation. Creates an IntegrationResponses.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property IntegrationId. The integration ID.

Gets and sets the property IntegrationResponseKey. The integration response key.

Gets and sets the property ResponseParameters. A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Gets and sets the property ResponseTemplates. The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Gets and sets the property TemplateSelectionExpression. The template selection expression for the integration response.

This is the response object from the CreateIntegrationResponse operation.

Gets and sets the property IntegrationResponseId. The integration response ID.

Gets and sets the property IntegrationResponseKey. The integration response key.

Gets and sets the property ResponseParameters. A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

Gets and sets the property TemplateSelectionExpression. The template selection expressions for the integration response.

Container for the parameters to the CreateModel operation. Creates a Model for an API.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property ContentType. The content-type for the model, for example, "application/json".

Gets and sets the property Description. The description of the model.

Gets and sets the property Name. The name of the model. Must be alphanumeric.

Gets and sets the property Schema. The schema for the model. For application/json models, this should be JSON schema draft 4 model.

This is the response object from the CreateModel operation.

Gets and sets the property ContentType. The content-type for the model, for example, "application/json".

Gets and sets the property Description. The description of the model.

Gets and sets the property ModelId. The model identifier.

Gets and sets the property Name. The name of the model. Must be alphanumeric.

Gets and sets the property Schema. The schema for the model. For application/json models, this should be JSON schema draft 4 model.

Container for the parameters to the CreateRoute operation. Creates a Route for an API.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property ApiKeyRequired. Specifies whether an API key is required for the route.

Gets and sets the property AuthorizationScopes. The authorization scopes supported by this route.

Gets and sets the property AuthorizationType. The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Gets and sets the property AuthorizerId. The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.

Gets and sets the property ModelSelectionExpression. The model selection expression for the route.

Gets and sets the property OperationName. The operation name for the route.

Gets and sets the property RequestModels. The request models for the route.

Gets and sets the property RequestParameters. The request parameters for the route.

Gets and sets the property RouteKey. The route key for the route.

Gets and sets the property RouteResponseSelectionExpression. The route response selection expression for the route.

Gets and sets the property Target. The target for the route.

This is the response object from the CreateRoute operation.

Gets and sets the property ApiKeyRequired. Specifies whether an API key is required for this route.

Gets and sets the property AuthorizationScopes. A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Gets and sets the property ModelSelectionExpression. The model selection expression for the route.

Gets and sets the property OperationName. The operation name for the route.

Gets and sets the property RequestModels. The request models for the route.

Gets and sets the property RequestParameters. The request parameters for the route.

Gets and sets the property RouteId. The route ID.

Gets and sets the property RouteKey. The route key for the route.

Gets and sets the property RouteResponseSelectionExpression. The route response selection expression for the route.

Gets and sets the property Target. The target for the route.

Container for the parameters to the CreateRouteResponse operation. Creates a RouteResponse for a Route.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property ModelSelectionExpression. The model selection expression for the route response.

Gets and sets the property ResponseModels. The response models for the route response.

Gets and sets the property ResponseParameters. The route response parameters.

Gets and sets the property RouteId. The route ID.

Gets and sets the property RouteResponseKey. The route response key.

This is the response object from the CreateRouteResponse operation.

Gets and sets the property ModelSelectionExpression. Represents the model selection expression of a route response.

Gets and sets the property ResponseModels. Represents the response models of a route response.

Gets and sets the property ResponseParameters. Represents the response parameters of a route response.

Gets and sets the property RouteResponseId. Represents the identifier of a route response.

Gets and sets the property RouteResponseKey. Represents the route response key of a route response.

Container for the parameters to the CreateStage operation. Creates a Stage for an API.

Gets and sets the property AccessLogSettings. Settings for logging access in this stage.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property ClientCertificateId. The identifier of a client certificate for a Stage.

Gets and sets the property DefaultRouteSettings. The default route settings for the stage.

Gets and sets the property DeploymentId. The deployment identifier of the API stage.

Gets and sets the property Description. The description for the API stage.

Gets and sets the property RouteSettings. Route settings for the stage.

Gets and sets the property StageName. The name of the stage.

This is the response object from the CreateStage operation.

Gets and sets the property AccessLogSettings. Settings for logging access in this stage.

Gets and sets the property ClientCertificateId. The identifier of a client certificate for a Stage.

Gets and sets the property CreatedDate. The timestamp when the stage was created.

Gets and sets the property DefaultRouteSettings. Default route settings for the stage.

Gets and sets the property DeploymentId. The identifier of the Deployment that the Stage is associated with.

Gets and sets the property Description. The description of the stage.

Gets and sets the property LastUpdatedDate. The timestamp when the stage was last updated.

Gets and sets the property RouteSettings. Route settings for the stage.

Gets and sets the property StageName. The name of the stage.

Container for the parameters to the DeleteApiMapping operation. Deletes an API mapping.

Gets and sets the property ApiMappingId. The API mapping identifier.

Gets and sets the property DomainName. The domain name.

This is the response object from the DeleteApiMapping operation.

Container for the parameters to the DeleteApi operation. Deletes an Api resource.

Gets and sets the property ApiId. The API identifier.

This is the response object from the DeleteApi operation.

Container for the parameters to the DeleteAuthorizer operation. Deletes an Authorizer.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property AuthorizerId. The authorizer identifier.

This is the response object from the DeleteAuthorizer operation.

Container for the parameters to the DeleteDeployment operation. Deletes a Deployment.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property DeploymentId. The deployment ID.

This is the response object from the DeleteDeployment operation.

Container for the parameters to the DeleteDomainName operation. Deletes a domain name.

Gets and sets the property DomainName. The domain name.

This is the response object from the DeleteDomainName operation.

Container for the parameters to the DeleteIntegration operation. Deletes an Integration.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property IntegrationId. The integration ID.

This is the response object from the DeleteIntegration operation.

Container for the parameters to the DeleteIntegrationResponse operation. Deletes an IntegrationResponses.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property IntegrationId. The integration ID.

Gets and sets the property IntegrationResponseId. The integration response ID.

This is the response object from the DeleteIntegrationResponse operation.

Container for the parameters to the DeleteModel operation. Deletes a Model.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property ModelId. The model ID.

This is the response object from the DeleteModel operation.

Container for the parameters to the DeleteRoute operation. Deletes a Route.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property RouteId. The route ID.

This is the response object from the DeleteRoute operation.

Container for the parameters to the DeleteRouteResponse operation. Deletes a RouteResponse.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property RouteId. The route ID.

Gets and sets the property RouteResponseId. The route response ID.

This is the response object from the DeleteRouteResponse operation.

Container for the parameters to the DeleteStage operation. Deletes a Stage.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property StageName. The stage name.

This is the response object from the DeleteStage operation.

An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.

Gets and sets the property CreatedDate. The date and time when the Deployment resource was created.

Gets and sets the property DeploymentId. The identifier for the deployment.

Gets and sets the property DeploymentStatus. The status of the deployment: PENDING, FAILED, or SUCCEEDED.

Gets and sets the property DeploymentStatusMessage. May contain additional feedback on the status of an API deployment.

Gets and sets the property Description. The description for the deployment.

Represents a domain name.

Gets and sets the property ApiMappingSelectionExpression. The API mapping selection expression.

Gets and sets the property DomainNameConfigurations. The domain name configurations.

Gets and sets the property Name. The name of the DomainName resource.

The domain name configuration.

Gets and sets the property ApiGatewayDomainName. A domain name for the WebSocket API.

Gets and sets the property CertificateArn. An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Gets and sets the property CertificateName. The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

Gets and sets the property CertificateUploadDate. The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Gets and sets the property EndpointType. The endpoint type.

Gets and sets the property HostedZoneId. The Amazon Route 53 Hosted Zone ID of the endpoint.

Container for the parameters to the GetApiMapping operation. The API mapping.

Gets and sets the property ApiMappingId. The API mapping identifier.

Gets and sets the property DomainName. The domain name.

This is the response object from the GetApiMapping operation.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property ApiMappingId. The API mapping identifier.

Gets and sets the property ApiMappingKey. The API mapping key.

Gets and sets the property Stage. The API stage.

Container for the parameters to the GetApiMappings operation. The API mappings.

Gets and sets the property DomainName. The domain name.

Gets and sets the property MaxResults. The maximum number of elements to be returned for this resource.

Gets and sets the property NextToken. The next page of elements from this collection. Not valid for the last element of the collection.

This is the response object from the GetApiMappings operation.

Gets and sets the property Items. The elements from this collection.

Gets and sets the property NextToken. The next page of elements from this collection. Not valid for the last element of the collection.

Container for the parameters to the GetApi operation. Gets an Api resource.

Gets and sets the property ApiId. The API identifier.

This is the response object from the GetApi operation.

Gets and sets the property ApiId. The API ID.

Gets and sets the property ApiKeySelectionExpression. An API key selection expression. See API Key Selection Expressions.

Gets and sets the property CreatedDate. The timestamp when the API was created.

Gets and sets the property Description. The description of the API.

Gets and sets the property DisableSchemaValidation. Avoid validating models when creating a deployment.

Gets and sets the property Name. The name of the API.

Gets and sets the property ProtocolType. The API protocol: Currently only WEBSOCKET is supported.

Gets and sets the property RouteSelectionExpression. The route selection expression for the API.

Gets and sets the property Version. A version identifier for the API.

Gets and sets the property Warnings. The warning messages reported when failonwarnings is turned on during API import.

Container for the parameters to the GetApis operation. Gets a collection of Api resources.

Gets and sets the property MaxResults. The maximum number of elements to be returned for this resource.

Gets and sets the property NextToken. The next page of elements from this collection. Not valid for the last element of the collection.

This is the response object from the GetApis operation.

Gets and sets the property Items. The elements from this collection.

Gets and sets the property NextToken. The next page of elements from this collection. Not valid for the last element of the collection.

Container for the parameters to the GetAuthorizer operation. Gets an Authorizer.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property AuthorizerId. The authorizer identifier.

This is the response object from the GetAuthorizer operation.

Gets and sets the property AuthorizerId. The authorizer identifier.

Gets and sets the property AuthorizerType. The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Gets and sets the property IdentityValidationExpression. The validation expression does not apply to the REQUEST authorizer.

Gets and sets the property Name. The name of the authorizer.

Gets and sets the property ProviderArns. For REQUEST authorizer, this is not defined.

Container for the parameters to the GetAuthorizers operation. Gets the Authorizers for an API.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property MaxResults. The maximum number of elements to be returned for this resource.

Gets and sets the property NextToken. The next page of elements from this collection. Not valid for the last element of the collection.

This is the response object from the GetAuthorizers operation.

Gets and sets the property Items. The elements from this collection.

Gets and sets the property NextToken. The next page of elements from this collection. Not valid for the last element of the collection.

Container for the parameters to the GetDeployment operation. Gets a Deployment.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property DeploymentId. The deployment ID.

This is the response object from the GetDeployment operation.

Gets and sets the property CreatedDate. The date and time when the Deployment resource was created.

Gets and sets the property DeploymentId. The identifier for the deployment.

Gets and sets the property DeploymentStatus. The status of the deployment: PENDING, FAILED, or SUCCEEDED.

Gets and sets the property DeploymentStatusMessage. May contain additional feedback on the status of an API deployment.

Gets and sets the property Description. The description for the deployment.

Container for the parameters to the GetDeployments operation. Gets the Deployments for an API.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property MaxResults. The maximum number of elements to be returned for this resource.

Gets and sets the property NextToken. The next page of elements from this collection. Not valid for the last element of the collection.

This is the response object from the GetDeployments operation.

Gets and sets the property Items. The elements from this collection.

Gets and sets the property NextToken. The next page of elements from this collection. Not valid for the last element of the collection.

Container for the parameters to the GetDomainName operation. Gets a domain name.

Gets and sets the property DomainName. The domain name.

This is the response object from the GetDomainName operation.

Gets and sets the property ApiMappingSelectionExpression. The API mapping selection expression.

Gets and sets the property DomainName. The name of the DomainName resource.

Gets and sets the property DomainNameConfigurations. The domain name configurations.

Container for the parameters to the GetDomainNames operation. Gets the domain names for an AWS account.

Gets and sets the property MaxResults. The maximum number of elements to be returned for this resource.

Gets and sets the property NextToken. The next page of elements from this collection. Not valid for the last element of the collection.

This is the response object from the GetDomainNames operation.

Gets and sets the property Items. The elements from this collection.

Gets and sets the property NextToken. The next page of elements from this collection. Not valid for the last element of the collection.

Container for the parameters to the GetIntegration operation. Gets an Integration.

Gets and sets the property ApiId. The API identifier.

Gets and sets the property IntegrationId. The integration ID.

This is the response object from the GetIntegration operation.