ApiGatewayV2 class
Amazon API Gateway V2
Constructors
- ApiGatewayV2({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createApi(
{required String name, required ProtocolType protocolType, String? apiKeySelectionExpression, Cors? corsConfiguration, String? credentialsArn, String? description, bool? disableExecuteApiEndpoint, bool? disableSchemaValidation, IpAddressType? ipAddressType, String? routeKey, String? routeSelectionExpression, Map< String, String> ? tags, String? target, String? version}) → Future<CreateApiResponse> - Creates an Api resource.
-
createApiMapping(
{required String apiId, required String domainName, required String stage, String? apiMappingKey}) → Future< CreateApiMappingResponse> - Creates an API mapping.
-
createAuthorizer(
{required String apiId, required AuthorizerType authorizerType, required List< String> identitySource, required String name, String? authorizerCredentialsArn, String? authorizerPayloadFormatVersion, int? authorizerResultTtlInSeconds, String? authorizerUri, bool? enableSimpleResponses, String? identityValidationExpression, JWTConfiguration? jwtConfiguration}) → Future<CreateAuthorizerResponse> - Creates an Authorizer for an API.
-
createDeployment(
{required String apiId, String? description, String? stageName}) → Future< CreateDeploymentResponse> - Creates a Deployment for an API.
-
createDomainName(
{required String domainName, List< DomainNameConfiguration> ? domainNameConfigurations, MutualTlsAuthenticationInput? mutualTlsAuthentication, RoutingMode? routingMode, Map<String, String> ? tags}) → Future<CreateDomainNameResponse> - Creates a domain name.
-
createIntegration(
{required String apiId, required IntegrationType integrationType, String? connectionId, ConnectionType? connectionType, ContentHandlingStrategy? contentHandlingStrategy, String? credentialsArn, String? description, String? integrationMethod, String? integrationSubtype, String? integrationUri, PassthroughBehavior? passthroughBehavior, String? payloadFormatVersion, Map< String, String> ? requestParameters, Map<String, String> ? requestTemplates, Map<String, Map< ? responseParameters, String? templateSelectionExpression, int? timeoutInMillis, TlsConfigInput? tlsConfig}) → Future<String, String> >CreateIntegrationResult> - Creates an Integration.
-
createIntegrationResponse(
{required String apiId, required String integrationId, required String integrationResponseKey, ContentHandlingStrategy? contentHandlingStrategy, Map< String, String> ? responseParameters, Map<String, String> ? responseTemplates, String? templateSelectionExpression}) → Future<CreateIntegrationResponseResponse> - Creates an IntegrationResponses.
-
createModel(
{required String apiId, required String name, required String schema, String? contentType, String? description}) → Future< CreateModelResponse> - Creates a Model for an API.
-
createPortal(
{required Authorization authorization, required EndpointConfigurationRequest endpointConfiguration, required PortalContent portalContent, List< String> ? includedPortalProductArns, String? logoUri, String? rumAppMonitorName, Map<String, String> ? tags}) → Future<CreatePortalResponse> - Creates a portal.
-
createPortalProduct(
{required String displayName, String? description, Map< String, String> ? tags}) → Future<CreatePortalProductResponse> - Creates a new portal product.
-
createProductPage(
{required DisplayContent displayContent, required String portalProductId}) → Future< CreateProductPageResponse> - Creates a new product page for a portal product.
-
createProductRestEndpointPage(
{required String portalProductId, required RestEndpointIdentifier restEndpointIdentifier, EndpointDisplayContent? displayContent, TryItState? tryItState}) → Future< CreateProductRestEndpointPageResponse> - Creates a product REST endpoint page for a portal product.
-
createRoute(
{required String apiId, required String routeKey, bool? apiKeyRequired, List< String> ? authorizationScopes, AuthorizationType? authorizationType, String? authorizerId, String? modelSelectionExpression, String? operationName, Map<String, String> ? requestModels, Map<String, ParameterConstraints> ? requestParameters, String? routeResponseSelectionExpression, String? target}) → Future<CreateRouteResult> - Creates a Route for an API.
-
createRouteResponse(
{required String apiId, required String routeId, required String routeResponseKey, String? modelSelectionExpression, Map< String, String> ? responseModels, Map<String, ParameterConstraints> ? responseParameters}) → Future<CreateRouteResponseResponse> - Creates a RouteResponse for a Route.
-
createRoutingRule(
{required List< RoutingRuleAction> actions, required List<RoutingRuleCondition> conditions, required String domainName, required int priority, String? domainNameId}) → Future<CreateRoutingRuleResponse> - Creates a RoutingRule.
-
createStage(
{required String apiId, required String stageName, AccessLogSettings? accessLogSettings, bool? autoDeploy, String? clientCertificateId, RouteSettings? defaultRouteSettings, String? deploymentId, String? description, Map< String, RouteSettings> ? routeSettings, Map<String, String> ? stageVariables, Map<String, String> ? tags}) → Future<CreateStageResponse> - Creates a Stage for an API.
-
createVpcLink(
{required String name, required List< String> subnetIds, List<String> ? securityGroupIds, Map<String, String> ? tags}) → Future<CreateVpcLinkResponse> - Creates a VPC link.
-
deleteAccessLogSettings(
{required String apiId, required String stageName}) → Future< void> - Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.
-
deleteApi(
{required String apiId}) → Future< void> - Deletes an Api resource.
-
deleteApiMapping(
{required String apiMappingId, required String domainName}) → Future< void> - Deletes an API mapping.
-
deleteAuthorizer(
{required String apiId, required String authorizerId}) → Future< void> - Deletes an Authorizer.
-
deleteCorsConfiguration(
{required String apiId}) → Future< void> - Deletes a CORS configuration.
-
deleteDeployment(
{required String apiId, required String deploymentId}) → Future< void> - Deletes a Deployment.
-
deleteDomainName(
{required String domainName}) → Future< void> - Deletes a domain name.
-
deleteIntegration(
{required String apiId, required String integrationId}) → Future< void> - Deletes an Integration.
-
deleteIntegrationResponse(
{required String apiId, required String integrationId, required String integrationResponseId}) → Future< void> - Deletes an IntegrationResponses.
-
deleteModel(
{required String apiId, required String modelId}) → Future< void> - Deletes a Model.
-
deletePortal(
{required String portalId}) → Future< void> - Deletes a portal.
-
deletePortalProduct(
{required String portalProductId}) → Future< void> - Deletes a portal product.
-
deletePortalProductSharingPolicy(
{required String portalProductId}) → Future< void> - Deletes the sharing policy for a portal product.
-
deleteProductPage(
{required String portalProductId, required String productPageId}) → Future< void> - Deletes a product page of a portal product.
-
deleteProductRestEndpointPage(
{required String portalProductId, required String productRestEndpointPageId}) → Future< void> - Deletes a product REST endpoint page.
-
deleteRoute(
{required String apiId, required String routeId}) → Future< void> - Deletes a Route.
-
deleteRouteRequestParameter(
{required String apiId, required String requestParameterKey, required String routeId}) → Future< void> - Deletes a route request parameter. Supported only for WebSocket APIs.
-
deleteRouteResponse(
{required String apiId, required String routeId, required String routeResponseId}) → Future< void> - Deletes a RouteResponse.
-
deleteRouteSettings(
{required String apiId, required String routeKey, required String stageName}) → Future< void> - Deletes the RouteSettings for a stage.
-
deleteRoutingRule(
{required String domainName, required String routingRuleId, String? domainNameId}) → Future< void> - Deletes a routing rule.
-
deleteStage(
{required String apiId, required String stageName}) → Future< void> - Deletes a Stage.
-
deleteVpcLink(
{required String vpcLinkId}) → Future< void> - Deletes a VPC link.
-
disablePortal(
{required String portalId}) → Future< void> - Deletes the publication of a portal portal.
-
exportApi(
{required String apiId, required String outputType, required String specification, String? exportVersion, bool? includeExtensions, String? stageName}) → Future< ExportApiResponse> -
May throw
BadRequestException. May throwNotFoundException. May throwTooManyRequestsException. -
getApi(
{required String apiId}) → Future< GetApiResponse> - Gets an Api resource.
-
getApiMapping(
{required String apiMappingId, required String domainName}) → Future< GetApiMappingResponse> - Gets an API mapping.
-
getApiMappings(
{required String domainName, String? maxResults, String? nextToken}) → Future< GetApiMappingsResponse> - Gets API mappings.
-
getApis(
{String? maxResults, String? nextToken}) → Future< GetApisResponse> - Gets a collection of Api resources.
-
getAuthorizer(
{required String apiId, required String authorizerId}) → Future< GetAuthorizerResponse> - Gets an Authorizer.
-
getAuthorizers(
{required String apiId, String? maxResults, String? nextToken}) → Future< GetAuthorizersResponse> - Gets the Authorizers for an API.
-
getDeployment(
{required String apiId, required String deploymentId}) → Future< GetDeploymentResponse> - Gets a Deployment.
-
getDeployments(
{required String apiId, String? maxResults, String? nextToken}) → Future< GetDeploymentsResponse> - Gets the Deployments for an API.
-
getDomainName(
{required String domainName}) → Future< GetDomainNameResponse> - Gets a domain name.
-
getDomainNames(
{String? maxResults, String? nextToken}) → Future< GetDomainNamesResponse> - Gets the domain names for an AWS account.
-
getIntegration(
{required String apiId, required String integrationId}) → Future< GetIntegrationResult> - Gets an Integration.
-
getIntegrationResponse(
{required String apiId, required String integrationId, required String integrationResponseId}) → Future< GetIntegrationResponseResponse> - Gets an IntegrationResponses.
-
getIntegrationResponses(
{required String apiId, required String integrationId, String? maxResults, String? nextToken}) → Future< GetIntegrationResponsesResponse> - Gets the IntegrationResponses for an Integration.
-
getIntegrations(
{required String apiId, String? maxResults, String? nextToken}) → Future< GetIntegrationsResponse> - Gets the Integrations for an API.
-
getModel(
{required String apiId, required String modelId}) → Future< GetModelResponse> - Gets a Model.
-
getModels(
{required String apiId, String? maxResults, String? nextToken}) → Future< GetModelsResponse> - Gets the Models for an API.
-
getModelTemplate(
{required String apiId, required String modelId}) → Future< GetModelTemplateResponse> - Gets a model template.
-
getPortal(
{required String portalId}) → Future< GetPortalResponse> - Gets a portal.
-
getPortalProduct(
{required String portalProductId, String? resourceOwnerAccountId}) → Future< GetPortalProductResponse> - Gets a portal product.
-
getPortalProductSharingPolicy(
{required String portalProductId}) → Future< GetPortalProductSharingPolicyResponse> - Gets the sharing policy for a portal product.
-
getProductPage(
{required String portalProductId, required String productPageId, String? resourceOwnerAccountId}) → Future< GetProductPageResponse> - Gets a product page of a portal product.
-
getProductRestEndpointPage(
{required String portalProductId, required String productRestEndpointPageId, String? includeRawDisplayContent, String? resourceOwnerAccountId}) → Future< GetProductRestEndpointPageResponse> - Gets a product REST endpoint page.
-
getRoute(
{required String apiId, required String routeId}) → Future< GetRouteResult> - Gets a Route.
-
getRouteResponse(
{required String apiId, required String routeId, required String routeResponseId}) → Future< GetRouteResponseResponse> - Gets a RouteResponse.
-
getRouteResponses(
{required String apiId, required String routeId, String? maxResults, String? nextToken}) → Future< GetRouteResponsesResponse> - Gets the RouteResponses for a Route.
-
getRoutes(
{required String apiId, String? maxResults, String? nextToken}) → Future< GetRoutesResponse> - Gets the Routes for an API.
-
getRoutingRule(
{required String domainName, required String routingRuleId, String? domainNameId}) → Future< GetRoutingRuleResponse> - Gets a routing rule.
-
getStage(
{required String apiId, required String stageName}) → Future< GetStageResponse> - Gets a Stage.
-
getStages(
{required String apiId, String? maxResults, String? nextToken}) → Future< GetStagesResponse> - Gets the Stages for an API.
-
getTags(
{required String resourceArn}) → Future< GetTagsResponse> - Gets a collection of Tag resources.
-
getVpcLink(
{required String vpcLinkId}) → Future< GetVpcLinkResponse> - Gets a VPC link.
-
getVpcLinks(
{String? maxResults, String? nextToken}) → Future< GetVpcLinksResponse> - Gets a collection of VPC links.
-
importApi(
{required String body, String? basepath, bool? failOnWarnings}) → Future< ImportApiResponse> - Imports an API.
-
listPortalProducts(
{String? maxResults, String? nextToken, String? resourceOwner}) → Future< ListPortalProductsResponse> - Lists portal products.
-
listPortals(
{String? maxResults, String? nextToken}) → Future< ListPortalsResponse> - Lists portals.
-
listProductPages(
{required String portalProductId, String? maxResults, String? nextToken, String? resourceOwnerAccountId}) → Future< ListProductPagesResponse> - Lists the product pages for a portal product.
-
listProductRestEndpointPages(
{required String portalProductId, String? maxResults, String? nextToken, String? resourceOwnerAccountId}) → Future< ListProductRestEndpointPagesResponse> - Lists the product REST endpoint pages of a portal product.
-
listRoutingRules(
{required String domainName, String? domainNameId, int? maxResults, String? nextToken}) → Future< ListRoutingRulesResponse> - Lists routing rules.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
previewPortal(
{required String portalId}) → Future< void> - Creates a portal preview.
-
publishPortal(
{required String portalId, String? description}) → Future< void> - Publishes a portal.
-
putPortalProductSharingPolicy(
{required String policyDocument, required String portalProductId}) → Future< void> - Updates the sharing policy for a portal product.
-
putRoutingRule(
{required List< RoutingRuleAction> actions, required List<RoutingRuleCondition> conditions, required String domainName, required int priority, required String routingRuleId, String? domainNameId}) → Future<PutRoutingRuleResponse> - Updates a routing rule.
-
reimportApi(
{required String apiId, required String body, String? basepath, bool? failOnWarnings}) → Future< ReimportApiResponse> - Puts an Api resource.
-
resetAuthorizersCache(
{required String apiId, required String stageName}) → Future< void> - Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.
-
tagResource(
{required String resourceArn, Map< String, String> ? tags}) → Future<void> - Creates a new Tag resource to represent a tag.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Deletes a Tag.
-
updateApi(
{required String apiId, String? apiKeySelectionExpression, Cors? corsConfiguration, String? credentialsArn, String? description, bool? disableExecuteApiEndpoint, bool? disableSchemaValidation, IpAddressType? ipAddressType, String? name, String? routeKey, String? routeSelectionExpression, String? target, String? version}) → Future< UpdateApiResponse> - Updates an Api resource.
-
updateApiMapping(
{required String apiId, required String apiMappingId, required String domainName, String? apiMappingKey, String? stage}) → Future< UpdateApiMappingResponse> - The API mapping.
-
updateAuthorizer(
{required String apiId, required String authorizerId, String? authorizerCredentialsArn, String? authorizerPayloadFormatVersion, int? authorizerResultTtlInSeconds, AuthorizerType? authorizerType, String? authorizerUri, bool? enableSimpleResponses, List< String> ? identitySource, String? identityValidationExpression, JWTConfiguration? jwtConfiguration, String? name}) → Future<UpdateAuthorizerResponse> - Updates an Authorizer.
-
updateDeployment(
{required String apiId, required String deploymentId, String? description}) → Future< UpdateDeploymentResponse> - Updates a Deployment.
-
updateDomainName(
{required String domainName, List< DomainNameConfiguration> ? domainNameConfigurations, MutualTlsAuthenticationInput? mutualTlsAuthentication, RoutingMode? routingMode}) → Future<UpdateDomainNameResponse> - Updates a domain name.
-
updateIntegration(
{required String apiId, required String integrationId, String? connectionId, ConnectionType? connectionType, ContentHandlingStrategy? contentHandlingStrategy, String? credentialsArn, String? description, String? integrationMethod, String? integrationSubtype, IntegrationType? integrationType, String? integrationUri, PassthroughBehavior? passthroughBehavior, String? payloadFormatVersion, Map< String, String> ? requestParameters, Map<String, String> ? requestTemplates, Map<String, Map< ? responseParameters, String? templateSelectionExpression, int? timeoutInMillis, TlsConfigInput? tlsConfig}) → Future<String, String> >UpdateIntegrationResult> - Updates an Integration.
-
updateIntegrationResponse(
{required String apiId, required String integrationId, required String integrationResponseId, ContentHandlingStrategy? contentHandlingStrategy, String? integrationResponseKey, Map< String, String> ? responseParameters, Map<String, String> ? responseTemplates, String? templateSelectionExpression}) → Future<UpdateIntegrationResponseResponse> - Updates an IntegrationResponses.
-
updateModel(
{required String apiId, required String modelId, String? contentType, String? description, String? name, String? schema}) → Future< UpdateModelResponse> - Updates a Model.
-
updatePortal(
{required String portalId, Authorization? authorization, EndpointConfigurationRequest? endpointConfiguration, List< String> ? includedPortalProductArns, String? logoUri, PortalContent? portalContent, String? rumAppMonitorName}) → Future<UpdatePortalResponse> - Updates a portal.
-
updatePortalProduct(
{required String portalProductId, String? description, String? displayName, DisplayOrder? displayOrder}) → Future< UpdatePortalProductResponse> - Updates the portal product.
-
updateProductPage(
{required String portalProductId, required String productPageId, DisplayContent? displayContent}) → Future< UpdateProductPageResponse> - Updates a product page of a portal product.
-
updateProductRestEndpointPage(
{required String portalProductId, required String productRestEndpointPageId, EndpointDisplayContent? displayContent, TryItState? tryItState}) → Future< UpdateProductRestEndpointPageResponse> - Updates a product REST endpoint page.
-
updateRoute(
{required String apiId, required String routeId, bool? apiKeyRequired, List< String> ? authorizationScopes, AuthorizationType? authorizationType, String? authorizerId, String? modelSelectionExpression, String? operationName, Map<String, String> ? requestModels, Map<String, ParameterConstraints> ? requestParameters, String? routeKey, String? routeResponseSelectionExpression, String? target}) → Future<UpdateRouteResult> - Updates a Route.
-
updateRouteResponse(
{required String apiId, required String routeId, required String routeResponseId, String? modelSelectionExpression, Map< String, String> ? responseModels, Map<String, ParameterConstraints> ? responseParameters, String? routeResponseKey}) → Future<UpdateRouteResponseResponse> - Updates a RouteResponse.
-
updateStage(
{required String apiId, required String stageName, AccessLogSettings? accessLogSettings, bool? autoDeploy, String? clientCertificateId, RouteSettings? defaultRouteSettings, String? deploymentId, String? description, Map< String, RouteSettings> ? routeSettings, Map<String, String> ? stageVariables}) → Future<UpdateStageResponse> - Updates a Stage.
-
updateVpcLink(
{required String vpcLinkId, String? name}) → Future< UpdateVpcLinkResponse> - Updates a VPC link.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited