updateApi method

Future<UpdateApiResponse> updateApi({ required String apiId, String? apiKeySelectionExpression, Cors? corsConfiguration, String? credentialsArn, String? description, bool? disableExecuteApiEndpoint, bool? disableSchemaValidation, String? name, String? routeKey, String? routeSelectionExpression, String? target, String? version, })

Updates an Api resource.

May throw NotFoundException. May throw TooManyRequestsException. May throw BadRequestException. May throw ConflictException.

Parameter apiId : The API identifier.

Parameter apiKeySelectionExpression : An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

Parameter corsConfiguration : A CORS configuration. Supported only for HTTP APIs.

Parameter credentialsArn : This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

Parameter description : The description of the API.

Parameter disableExecuteApiEndpoint : 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.

Parameter disableSchemaValidation : Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

Parameter name : The name of the API.

Parameter routeKey : This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

Parameter routeSelectionExpression : 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.

Parameter target : This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

Parameter version : A version identifier for the API.

Implementation

Future<UpdateApiResponse> updateApi({
  required String apiId,
  String? apiKeySelectionExpression,
  Cors? corsConfiguration,
  String? credentialsArn,
  String? description,
  bool? disableExecuteApiEndpoint,
  bool? disableSchemaValidation,
  String? name,
  String? routeKey,
  String? routeSelectionExpression,
  String? target,
  String? version,
}) async {
  ArgumentError.checkNotNull(apiId, 'apiId');
  final $payload = <String, dynamic>{
    if (apiKeySelectionExpression != null)
      'apiKeySelectionExpression': apiKeySelectionExpression,
    if (corsConfiguration != null) 'corsConfiguration': corsConfiguration,
    if (credentialsArn != null) 'credentialsArn': credentialsArn,
    if (description != null) 'description': description,
    if (disableExecuteApiEndpoint != null)
      'disableExecuteApiEndpoint': disableExecuteApiEndpoint,
    if (disableSchemaValidation != null)
      'disableSchemaValidation': disableSchemaValidation,
    if (name != null) 'name': name,
    if (routeKey != null) 'routeKey': routeKey,
    if (routeSelectionExpression != null)
      'routeSelectionExpression': routeSelectionExpression,
    if (target != null) 'target': target,
    if (version != null) 'version': version,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PATCH',
    requestUri: '/v2/apis/${Uri.encodeComponent(apiId)}',
    exceptionFnMap: _exceptionFns,
  );
  return UpdateApiResponse.fromJson(response);
}