AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessDeniedException

Class AccessLogSettings

Settings for logging access in a stage.

Class Api

Represents an API.

Class ApiMapping

Represents an API mapping.

Class Authorizer

Represents an authorizer.

Class BadRequestException

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

Class 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.

Class Cors

Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Class CreateApiMappingRequest

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

Class CreateApiMappingResponse

This is the response object from the CreateApiMapping operation.

Class CreateApiRequest

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

Class CreateApiResponse

This is the response object from the CreateApi operation.

Class CreateAuthorizerRequest

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

Class CreateAuthorizerResponse

This is the response object from the CreateAuthorizer operation.

Class CreateDeploymentRequest

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

Class CreateDeploymentResponse

This is the response object from the CreateDeployment operation.

Class CreateDomainNameRequest

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

Class CreateDomainNameResponse

This is the response object from the CreateDomainName operation.

Class CreateIntegrationRequest

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

Class CreateIntegrationResponse

This is the response object from the CreateIntegration operation.

Class CreateIntegrationResponseRequest

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

Class CreateIntegrationResponseResponse

This is the response object from the CreateIntegrationResponse operation.

Class CreateModelRequest

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

Class CreateModelResponse

This is the response object from the CreateModel operation.

Class CreateRouteRequest

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

Class CreateRouteResponse

This is the response object from the CreateRoute operation.

Class CreateRouteResponseRequest

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

Class CreateRouteResponseResponse

This is the response object from the CreateRouteResponse operation.

Class CreateStageRequest

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

Class CreateStageResponse

This is the response object from the CreateStage operation.

Class CreateVpcLinkRequest

Container for the parameters to the CreateVpcLink operation. Creates a VPC link.

Class CreateVpcLinkResponse

This is the response object from the CreateVpcLink operation.

Class DeleteAccessLogSettingsRequest

Container for the parameters to the DeleteAccessLogSettings operation. Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.

Class DeleteAccessLogSettingsResponse

This is the response object from the DeleteAccessLogSettings operation.

Class DeleteApiMappingRequest

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

Class DeleteApiMappingResponse

This is the response object from the DeleteApiMapping operation.

Class DeleteApiRequest

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

Class DeleteApiResponse

This is the response object from the DeleteApi operation.

Class DeleteAuthorizerRequest

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

Class DeleteAuthorizerResponse

This is the response object from the DeleteAuthorizer operation.

Class DeleteCorsConfigurationRequest

Container for the parameters to the DeleteCorsConfiguration operation. Deletes a CORS configuration.

Class DeleteCorsConfigurationResponse

This is the response object from the DeleteCorsConfiguration operation.

Class DeleteDeploymentRequest

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

Class DeleteDeploymentResponse

This is the response object from the DeleteDeployment operation.

Class DeleteDomainNameRequest

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

Class DeleteDomainNameResponse

This is the response object from the DeleteDomainName operation.

Class DeleteIntegrationRequest

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

Class DeleteIntegrationResponse

This is the response object from the DeleteIntegration operation.

Class DeleteIntegrationResponseRequest

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

Class DeleteIntegrationResponseResponse

This is the response object from the DeleteIntegrationResponse operation.

Class DeleteModelRequest

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

Class DeleteModelResponse

This is the response object from the DeleteModel operation.

Class DeleteRouteRequest

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

Class DeleteRouteRequestParameterRequest

Container for the parameters to the DeleteRouteRequestParameter operation. Deletes a route request parameter. Supported only for WebSocket APIs.

Class DeleteRouteRequestParameterResponse

This is the response object from the DeleteRouteRequestParameter operation.

Class DeleteRouteResponse

This is the response object from the DeleteRoute operation.

Class DeleteRouteResponseRequest

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

Class DeleteRouteResponseResponse

This is the response object from the DeleteRouteResponse operation.

Class DeleteRouteSettingsRequest

Container for the parameters to the DeleteRouteSettings operation. Deletes the RouteSettings for a stage.

Class DeleteRouteSettingsResponse

This is the response object from the DeleteRouteSettings operation.

Class DeleteStageRequest

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

Class DeleteStageResponse

This is the response object from the DeleteStage operation.

Class DeleteVpcLinkRequest

Container for the parameters to the DeleteVpcLink operation. Deletes a VPC link.

Class DeleteVpcLinkResponse

This is the response object from the DeleteVpcLink operation.

Class Deployment

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.

Class DomainName

Represents a domain name.

Class DomainNameConfiguration

The domain name configuration.

Class ExportApiRequest

Container for the parameters to the ExportApi operation.

Class ExportApiResponse

This is the response object from the ExportApi operation.

Class GetApiMappingRequest

Container for the parameters to the GetApiMapping operation. Gets an API mapping.

Class GetApiMappingResponse

This is the response object from the GetApiMapping operation.

Class GetApiMappingsRequest

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

Class GetApiMappingsResponse

This is the response object from the GetApiMappings operation.

Class GetApiRequest

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

Class GetApiResponse

This is the response object from the GetApi operation.

Class GetApisRequest

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

Class GetApisResponse

This is the response object from the GetApis operation.

Class GetAuthorizerRequest

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

Class GetAuthorizerResponse

This is the response object from the GetAuthorizer operation.

Class GetAuthorizersRequest

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

Class GetAuthorizersResponse

This is the response object from the GetAuthorizers operation.

Class GetDeploymentRequest

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

Class GetDeploymentResponse

This is the response object from the GetDeployment operation.

Class GetDeploymentsRequest

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

Class GetDeploymentsResponse

This is the response object from the GetDeployments operation.

Class GetDomainNameRequest

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

Class GetDomainNameResponse

This is the response object from the GetDomainName operation.

Class GetDomainNamesRequest

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

Class GetDomainNamesResponse

This is the response object from the GetDomainNames operation.

Class GetIntegrationRequest

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

Class GetIntegrationResponse

This is the response object from the GetIntegration operation.

Class GetIntegrationResponseRequest

Container for the parameters to the GetIntegrationResponse operation. Gets an IntegrationResponses.

Class GetIntegrationResponseResponse

This is the response object from the GetIntegrationResponse operation.

Class GetIntegrationResponsesRequest

Container for the parameters to the GetIntegrationResponses operation. Gets the IntegrationResponses for an Integration.

Class GetIntegrationResponsesResponse

This is the response object from the GetIntegrationResponses operation.

Class GetIntegrationsRequest

Container for the parameters to the GetIntegrations operation. Gets the Integrations for an API.

Class GetIntegrationsResponse

This is the response object from the GetIntegrations operation.

Class GetModelRequest

Container for the parameters to the GetModel operation. Gets a Model.

Class GetModelResponse

This is the response object from the GetModel operation.

Class GetModelsRequest

Container for the parameters to the GetModels operation. Gets the Models for an API.

Class GetModelsResponse

This is the response object from the GetModels operation.

Class GetModelTemplateRequest

Container for the parameters to the GetModelTemplate operation. Gets a model template.

Class GetModelTemplateResponse

This is the response object from the GetModelTemplate operation.

Class GetRouteRequest

Container for the parameters to the GetRoute operation. Gets a Route.

Class GetRouteResponse

This is the response object from the GetRoute operation.

Class GetRouteResponseRequest

Container for the parameters to the GetRouteResponse operation. Gets a RouteResponse.

Class GetRouteResponseResponse

This is the response object from the GetRouteResponse operation.

Class GetRouteResponsesRequest

Container for the parameters to the GetRouteResponses operation. Gets the RouteResponses for a Route.

Class GetRouteResponsesResponse

This is the response object from the GetRouteResponses operation.

Class GetRoutesRequest

Container for the parameters to the GetRoutes operation. Gets the Routes for an API.

Class GetRoutesResponse

This is the response object from the GetRoutes operation.

Class GetStageRequest

Container for the parameters to the GetStage operation. Gets a Stage.

Class GetStageResponse

This is the response object from the GetStage operation.

Class GetStagesRequest

Container for the parameters to the GetStages operation. Gets the Stages for an API.

Class GetStagesResponse

This is the response object from the GetStages operation.

Class GetTagsRequest

Container for the parameters to the GetTags operation. Gets a collection of Tag resources.

Class GetTagsResponse

This is the response object from the GetTags operation.

Class GetVpcLinkRequest

Container for the parameters to the GetVpcLink operation. Gets a VPC link.

Class GetVpcLinkResponse

This is the response object from the GetVpcLink operation.

Class GetVpcLinksRequest

Container for the parameters to the GetVpcLinks operation. Gets a collection of VPC links.

Class GetVpcLinksResponse

This is the response object from the GetVpcLinks operation.

Class ImportApiRequest

Container for the parameters to the ImportApi operation. Imports an API.

Class ImportApiResponse

This is the response object from the ImportApi operation.

Class Integration

Represents an integration.

Class IntegrationResponse

Represents an integration response.

Class JWTConfiguration

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

Class Model

Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.

Class MutualTlsAuthentication

Class MutualTlsAuthenticationInput

Class NotFoundException

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

Class ParameterConstraints

Validation constraints imposed on parameters of a request (path, query string, headers).

Class ReimportApiRequest

Container for the parameters to the ReimportApi operation. Puts an Api resource.

Class ReimportApiResponse

This is the response object from the ReimportApi operation.

Class ResetAuthorizersCacheRequest

Container for the parameters to the ResetAuthorizersCache operation. Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.

Class ResetAuthorizersCacheResponse

This is the response object from the ResetAuthorizersCache operation.

Class Route

Represents a route.

Class RouteResponse

Represents a route response.

Class RouteSettings

Represents a collection of route settings.

Class Stage

Represents an API stage.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Creates a new Tag resource to represent a tag.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class TlsConfig

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Class TlsConfigInput

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Class TooManyRequestsException

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

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Deletes a Tag.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateApiMappingRequest

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

Class UpdateApiMappingResponse

This is the response object from the UpdateApiMapping operation.

Class UpdateApiRequest

Container for the parameters to the UpdateApi operation. Updates an Api resource.

Class UpdateApiResponse

This is the response object from the UpdateApi operation.

Class UpdateAuthorizerRequest

Container for the parameters to the UpdateAuthorizer operation. Updates an Authorizer.

Class UpdateAuthorizerResponse

This is the response object from the UpdateAuthorizer operation.

Class UpdateDeploymentRequest

Container for the parameters to the UpdateDeployment operation. Updates a Deployment.

Class UpdateDeploymentResponse

This is the response object from the UpdateDeployment operation.

Class UpdateDomainNameRequest

Container for the parameters to the UpdateDomainName operation. Updates a domain name.

Class UpdateDomainNameResponse

This is the response object from the UpdateDomainName operation.

Class UpdateIntegrationRequest

Container for the parameters to the UpdateIntegration operation. Updates an Integration.

Class UpdateIntegrationResponse

This is the response object from the UpdateIntegration operation.

Class UpdateIntegrationResponseRequest

Container for the parameters to the UpdateIntegrationResponse operation. Updates an IntegrationResponses.

Class UpdateIntegrationResponseResponse

This is the response object from the UpdateIntegrationResponse operation.

Class UpdateModelRequest

Container for the parameters to the UpdateModel operation. Updates a Model.

Class UpdateModelResponse

This is the response object from the UpdateModel operation.

Class UpdateRouteRequest

Container for the parameters to the UpdateRoute operation. Updates a Route.

Class UpdateRouteResponse

This is the response object from the UpdateRoute operation.

Class UpdateRouteResponseRequest

Container for the parameters to the UpdateRouteResponse operation. Updates a RouteResponse.

Class UpdateRouteResponseResponse

This is the response object from the UpdateRouteResponse operation.

Class UpdateStageRequest

Container for the parameters to the UpdateStage operation. Updates a Stage.

Class UpdateStageResponse

This is the response object from the UpdateStage operation.

Class UpdateVpcLinkRequest

Container for the parameters to the UpdateVpcLink operation. Updates a VPC link.

Class UpdateVpcLinkResponse

This is the response object from the UpdateVpcLink operation.

Class VpcLink

Represents a VPC link.