software.amazon.awssdk.services.apigateway.ApiGatewayClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of apigateway Show documentation
Show all versions of apigateway Show documentation
The AWS Java SDK for Amazon API Gateway module holds the client classes that are used for communicating
with Amazon API
Gateway
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.apigateway;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.apigateway.model.ApiGatewayException;
import software.amazon.awssdk.services.apigateway.model.BadRequestException;
import software.amazon.awssdk.services.apigateway.model.ConflictException;
import software.amazon.awssdk.services.apigateway.model.CreateApiKeyRequest;
import software.amazon.awssdk.services.apigateway.model.CreateApiKeyResponse;
import software.amazon.awssdk.services.apigateway.model.CreateAuthorizerRequest;
import software.amazon.awssdk.services.apigateway.model.CreateAuthorizerResponse;
import software.amazon.awssdk.services.apigateway.model.CreateBasePathMappingRequest;
import software.amazon.awssdk.services.apigateway.model.CreateBasePathMappingResponse;
import software.amazon.awssdk.services.apigateway.model.CreateDeploymentRequest;
import software.amazon.awssdk.services.apigateway.model.CreateDeploymentResponse;
import software.amazon.awssdk.services.apigateway.model.CreateDocumentationPartRequest;
import software.amazon.awssdk.services.apigateway.model.CreateDocumentationPartResponse;
import software.amazon.awssdk.services.apigateway.model.CreateDocumentationVersionRequest;
import software.amazon.awssdk.services.apigateway.model.CreateDocumentationVersionResponse;
import software.amazon.awssdk.services.apigateway.model.CreateDomainNameRequest;
import software.amazon.awssdk.services.apigateway.model.CreateDomainNameResponse;
import software.amazon.awssdk.services.apigateway.model.CreateModelRequest;
import software.amazon.awssdk.services.apigateway.model.CreateModelResponse;
import software.amazon.awssdk.services.apigateway.model.CreateRequestValidatorRequest;
import software.amazon.awssdk.services.apigateway.model.CreateRequestValidatorResponse;
import software.amazon.awssdk.services.apigateway.model.CreateResourceRequest;
import software.amazon.awssdk.services.apigateway.model.CreateResourceResponse;
import software.amazon.awssdk.services.apigateway.model.CreateRestApiRequest;
import software.amazon.awssdk.services.apigateway.model.CreateRestApiResponse;
import software.amazon.awssdk.services.apigateway.model.CreateStageRequest;
import software.amazon.awssdk.services.apigateway.model.CreateStageResponse;
import software.amazon.awssdk.services.apigateway.model.CreateUsagePlanKeyRequest;
import software.amazon.awssdk.services.apigateway.model.CreateUsagePlanKeyResponse;
import software.amazon.awssdk.services.apigateway.model.CreateUsagePlanRequest;
import software.amazon.awssdk.services.apigateway.model.CreateUsagePlanResponse;
import software.amazon.awssdk.services.apigateway.model.CreateVpcLinkRequest;
import software.amazon.awssdk.services.apigateway.model.CreateVpcLinkResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteApiKeyRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteApiKeyResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteAuthorizerRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteAuthorizerResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteBasePathMappingRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteBasePathMappingResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteClientCertificateRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteClientCertificateResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteDeploymentRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteDeploymentResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteDocumentationPartRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteDocumentationPartResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteDocumentationVersionRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteDocumentationVersionResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteDomainNameRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteDomainNameResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteGatewayResponseRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteGatewayResponseResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteIntegrationRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteIntegrationResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteIntegrationResponseRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteIntegrationResponseResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteMethodRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteMethodResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteMethodResponseRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteMethodResponseResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteModelRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteModelResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteRequestValidatorRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteRequestValidatorResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteResourceRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteResourceResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteRestApiRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteRestApiResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteStageRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteStageResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteUsagePlanKeyRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteUsagePlanKeyResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteUsagePlanRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteUsagePlanResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteVpcLinkRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteVpcLinkResponse;
import software.amazon.awssdk.services.apigateway.model.FlushStageAuthorizersCacheRequest;
import software.amazon.awssdk.services.apigateway.model.FlushStageAuthorizersCacheResponse;
import software.amazon.awssdk.services.apigateway.model.FlushStageCacheRequest;
import software.amazon.awssdk.services.apigateway.model.FlushStageCacheResponse;
import software.amazon.awssdk.services.apigateway.model.GenerateClientCertificateRequest;
import software.amazon.awssdk.services.apigateway.model.GenerateClientCertificateResponse;
import software.amazon.awssdk.services.apigateway.model.GetAccountRequest;
import software.amazon.awssdk.services.apigateway.model.GetAccountResponse;
import software.amazon.awssdk.services.apigateway.model.GetApiKeyRequest;
import software.amazon.awssdk.services.apigateway.model.GetApiKeyResponse;
import software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest;
import software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse;
import software.amazon.awssdk.services.apigateway.model.GetAuthorizerRequest;
import software.amazon.awssdk.services.apigateway.model.GetAuthorizerResponse;
import software.amazon.awssdk.services.apigateway.model.GetAuthorizersRequest;
import software.amazon.awssdk.services.apigateway.model.GetAuthorizersResponse;
import software.amazon.awssdk.services.apigateway.model.GetBasePathMappingRequest;
import software.amazon.awssdk.services.apigateway.model.GetBasePathMappingResponse;
import software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest;
import software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse;
import software.amazon.awssdk.services.apigateway.model.GetClientCertificateRequest;
import software.amazon.awssdk.services.apigateway.model.GetClientCertificateResponse;
import software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest;
import software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse;
import software.amazon.awssdk.services.apigateway.model.GetDeploymentRequest;
import software.amazon.awssdk.services.apigateway.model.GetDeploymentResponse;
import software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest;
import software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationPartRequest;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationPartResponse;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationPartsRequest;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationPartsResponse;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationVersionRequest;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationVersionResponse;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationVersionsRequest;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationVersionsResponse;
import software.amazon.awssdk.services.apigateway.model.GetDomainNameRequest;
import software.amazon.awssdk.services.apigateway.model.GetDomainNameResponse;
import software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest;
import software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse;
import software.amazon.awssdk.services.apigateway.model.GetExportRequest;
import software.amazon.awssdk.services.apigateway.model.GetExportResponse;
import software.amazon.awssdk.services.apigateway.model.GetGatewayResponseRequest;
import software.amazon.awssdk.services.apigateway.model.GetGatewayResponseResponse;
import software.amazon.awssdk.services.apigateway.model.GetGatewayResponsesRequest;
import software.amazon.awssdk.services.apigateway.model.GetGatewayResponsesResponse;
import software.amazon.awssdk.services.apigateway.model.GetIntegrationRequest;
import software.amazon.awssdk.services.apigateway.model.GetIntegrationResponse;
import software.amazon.awssdk.services.apigateway.model.GetIntegrationResponseRequest;
import software.amazon.awssdk.services.apigateway.model.GetIntegrationResponseResponse;
import software.amazon.awssdk.services.apigateway.model.GetMethodRequest;
import software.amazon.awssdk.services.apigateway.model.GetMethodResponse;
import software.amazon.awssdk.services.apigateway.model.GetMethodResponseRequest;
import software.amazon.awssdk.services.apigateway.model.GetMethodResponseResponse;
import software.amazon.awssdk.services.apigateway.model.GetModelRequest;
import software.amazon.awssdk.services.apigateway.model.GetModelResponse;
import software.amazon.awssdk.services.apigateway.model.GetModelTemplateRequest;
import software.amazon.awssdk.services.apigateway.model.GetModelTemplateResponse;
import software.amazon.awssdk.services.apigateway.model.GetModelsRequest;
import software.amazon.awssdk.services.apigateway.model.GetModelsResponse;
import software.amazon.awssdk.services.apigateway.model.GetRequestValidatorRequest;
import software.amazon.awssdk.services.apigateway.model.GetRequestValidatorResponse;
import software.amazon.awssdk.services.apigateway.model.GetRequestValidatorsRequest;
import software.amazon.awssdk.services.apigateway.model.GetRequestValidatorsResponse;
import software.amazon.awssdk.services.apigateway.model.GetResourceRequest;
import software.amazon.awssdk.services.apigateway.model.GetResourceResponse;
import software.amazon.awssdk.services.apigateway.model.GetResourcesRequest;
import software.amazon.awssdk.services.apigateway.model.GetResourcesResponse;
import software.amazon.awssdk.services.apigateway.model.GetRestApiRequest;
import software.amazon.awssdk.services.apigateway.model.GetRestApiResponse;
import software.amazon.awssdk.services.apigateway.model.GetRestApisRequest;
import software.amazon.awssdk.services.apigateway.model.GetRestApisResponse;
import software.amazon.awssdk.services.apigateway.model.GetSdkRequest;
import software.amazon.awssdk.services.apigateway.model.GetSdkResponse;
import software.amazon.awssdk.services.apigateway.model.GetSdkTypeRequest;
import software.amazon.awssdk.services.apigateway.model.GetSdkTypeResponse;
import software.amazon.awssdk.services.apigateway.model.GetSdkTypesRequest;
import software.amazon.awssdk.services.apigateway.model.GetSdkTypesResponse;
import software.amazon.awssdk.services.apigateway.model.GetStageRequest;
import software.amazon.awssdk.services.apigateway.model.GetStageResponse;
import software.amazon.awssdk.services.apigateway.model.GetStagesRequest;
import software.amazon.awssdk.services.apigateway.model.GetStagesResponse;
import software.amazon.awssdk.services.apigateway.model.GetTagsRequest;
import software.amazon.awssdk.services.apigateway.model.GetTagsResponse;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeyRequest;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeyResponse;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlanRequest;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlanResponse;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse;
import software.amazon.awssdk.services.apigateway.model.GetUsageRequest;
import software.amazon.awssdk.services.apigateway.model.GetUsageResponse;
import software.amazon.awssdk.services.apigateway.model.GetVpcLinkRequest;
import software.amazon.awssdk.services.apigateway.model.GetVpcLinkResponse;
import software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest;
import software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse;
import software.amazon.awssdk.services.apigateway.model.ImportApiKeysRequest;
import software.amazon.awssdk.services.apigateway.model.ImportApiKeysResponse;
import software.amazon.awssdk.services.apigateway.model.ImportDocumentationPartsRequest;
import software.amazon.awssdk.services.apigateway.model.ImportDocumentationPartsResponse;
import software.amazon.awssdk.services.apigateway.model.ImportRestApiRequest;
import software.amazon.awssdk.services.apigateway.model.ImportRestApiResponse;
import software.amazon.awssdk.services.apigateway.model.LimitExceededException;
import software.amazon.awssdk.services.apigateway.model.NotFoundException;
import software.amazon.awssdk.services.apigateway.model.PutGatewayResponseRequest;
import software.amazon.awssdk.services.apigateway.model.PutGatewayResponseResponse;
import software.amazon.awssdk.services.apigateway.model.PutIntegrationRequest;
import software.amazon.awssdk.services.apigateway.model.PutIntegrationResponse;
import software.amazon.awssdk.services.apigateway.model.PutIntegrationResponseRequest;
import software.amazon.awssdk.services.apigateway.model.PutIntegrationResponseResponse;
import software.amazon.awssdk.services.apigateway.model.PutMethodRequest;
import software.amazon.awssdk.services.apigateway.model.PutMethodResponse;
import software.amazon.awssdk.services.apigateway.model.PutMethodResponseRequest;
import software.amazon.awssdk.services.apigateway.model.PutMethodResponseResponse;
import software.amazon.awssdk.services.apigateway.model.PutRestApiRequest;
import software.amazon.awssdk.services.apigateway.model.PutRestApiResponse;
import software.amazon.awssdk.services.apigateway.model.ServiceUnavailableException;
import software.amazon.awssdk.services.apigateway.model.TagResourceRequest;
import software.amazon.awssdk.services.apigateway.model.TagResourceResponse;
import software.amazon.awssdk.services.apigateway.model.TestInvokeAuthorizerRequest;
import software.amazon.awssdk.services.apigateway.model.TestInvokeAuthorizerResponse;
import software.amazon.awssdk.services.apigateway.model.TestInvokeMethodRequest;
import software.amazon.awssdk.services.apigateway.model.TestInvokeMethodResponse;
import software.amazon.awssdk.services.apigateway.model.TooManyRequestsException;
import software.amazon.awssdk.services.apigateway.model.UnauthorizedException;
import software.amazon.awssdk.services.apigateway.model.UntagResourceRequest;
import software.amazon.awssdk.services.apigateway.model.UntagResourceResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateAccountRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateAccountResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateApiKeyRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateApiKeyResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateAuthorizerRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateAuthorizerResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateBasePathMappingRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateBasePathMappingResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateClientCertificateRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateClientCertificateResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateDeploymentRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateDeploymentResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateDocumentationPartRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateDocumentationPartResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateDocumentationVersionRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateDocumentationVersionResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateDomainNameRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateDomainNameResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateGatewayResponseRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateGatewayResponseResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateIntegrationRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateIntegrationResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateIntegrationResponseRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateIntegrationResponseResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateMethodRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateMethodResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateMethodResponseRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateMethodResponseResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateModelRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateModelResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateRequestValidatorRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateRequestValidatorResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateResourceRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateResourceResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateRestApiRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateRestApiResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateStageRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateStageResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateUsagePlanRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateUsagePlanResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateUsageRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateUsageResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateVpcLinkRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateVpcLinkResponse;
import software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable;
import software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsIterable;
import software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable;
import software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsIterable;
import software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable;
import software.amazon.awssdk.services.apigateway.paginators.GetModelsIterable;
import software.amazon.awssdk.services.apigateway.paginators.GetResourcesIterable;
import software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable;
import software.amazon.awssdk.services.apigateway.paginators.GetUsageIterable;
import software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysIterable;
import software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable;
import software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable;
/**
* Service client for accessing Amazon API Gateway. This can be created using the static {@link #builder()} method.
*
* Amazon API Gateway
*
* Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API
* Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or
* other publicly addressable web services that are hosted outside of AWS.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface ApiGatewayClient extends AwsClient {
String SERVICE_NAME = "apigateway";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "apigateway";
/**
*
* Create an ApiKey resource.
*
*
* @param createApiKeyRequest
* Request to create an ApiKey resource.
* @return Result of the CreateApiKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateApiKey
*/
default CreateApiKeyResponse createApiKey(CreateApiKeyRequest createApiKeyRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Create an ApiKey resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateApiKeyRequest.Builder} avoiding the need to
* create one manually via {@link CreateApiKeyRequest#builder()}
*
*
* @param createApiKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateApiKeyRequest.Builder} to create a request.
* Request to create an ApiKey resource.
* @return Result of the CreateApiKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateApiKey
*/
default CreateApiKeyResponse createApiKey(Consumer createApiKeyRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return createApiKey(CreateApiKeyRequest.builder().applyMutation(createApiKeyRequest).build());
}
/**
*
* Create an ApiKey resource.
*
*
* @return Result of the CreateApiKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateApiKey
* @see #createApiKey(CreateApiKeyRequest)
*/
default CreateApiKeyResponse createApiKey() throws BadRequestException, ConflictException, LimitExceededException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return createApiKey(CreateApiKeyRequest.builder().build());
}
/**
*
* Adds a new Authorizer resource to an existing RestApi resource.
*
*
* @param createAuthorizerRequest
* Request to add a new Authorizer to an existing RestApi resource.
* @return Result of the CreateAuthorizer operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateAuthorizer
*/
default CreateAuthorizerResponse createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Adds a new Authorizer resource to an existing RestApi resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateAuthorizerRequest.Builder} avoiding the need
* to create one manually via {@link CreateAuthorizerRequest#builder()}
*
*
* @param createAuthorizerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateAuthorizerRequest.Builder} to create a
* request. Request to add a new Authorizer to an existing RestApi resource.
* @return Result of the CreateAuthorizer operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateAuthorizer
*/
default CreateAuthorizerResponse createAuthorizer(Consumer createAuthorizerRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return createAuthorizer(CreateAuthorizerRequest.builder().applyMutation(createAuthorizerRequest).build());
}
/**
*
* Creates a new BasePathMapping resource.
*
*
* @param createBasePathMappingRequest
* Requests API Gateway to create a new BasePathMapping resource.
* @return Result of the CreateBasePathMapping operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateBasePathMapping
*/
default CreateBasePathMappingResponse createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new BasePathMapping resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateBasePathMappingRequest.Builder} avoiding the
* need to create one manually via {@link CreateBasePathMappingRequest#builder()}
*
*
* @param createBasePathMappingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateBasePathMappingRequest.Builder} to create a
* request. Requests API Gateway to create a new BasePathMapping resource.
* @return Result of the CreateBasePathMapping operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateBasePathMapping
*/
default CreateBasePathMappingResponse createBasePathMapping(
Consumer createBasePathMappingRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return createBasePathMapping(CreateBasePathMappingRequest.builder().applyMutation(createBasePathMappingRequest).build());
}
/**
*
* Creates a Deployment resource, which makes a specified RestApi callable over the internet.
*
*
* @param createDeploymentRequest
* Requests API Gateway to create a Deployment resource.
* @return Result of the CreateDeployment operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ServiceUnavailableException
* The requested service is not available. For details see the accompanying error message. Retry after the
* specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateDeployment
*/
default CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a Deployment resource, which makes a specified RestApi callable over the internet.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDeploymentRequest.Builder} avoiding the need
* to create one manually via {@link CreateDeploymentRequest#builder()}
*
*
* @param createDeploymentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateDeploymentRequest.Builder} to create a
* request. Requests API Gateway to create a Deployment resource.
* @return Result of the CreateDeployment operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ServiceUnavailableException
* The requested service is not available. For details see the accompanying error message. Retry after the
* specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateDeployment
*/
default CreateDeploymentResponse createDeployment(Consumer createDeploymentRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, ApiGatewayException {
return createDeployment(CreateDeploymentRequest.builder().applyMutation(createDeploymentRequest).build());
}
/**
*
* Creates a documentation part.
*
*
* @param createDocumentationPartRequest
* Creates a new documentation part of a given API.
* @return Result of the CreateDocumentationPart operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateDocumentationPart
*/
default CreateDocumentationPartResponse createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a documentation part.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDocumentationPartRequest.Builder} avoiding
* the need to create one manually via {@link CreateDocumentationPartRequest#builder()}
*
*
* @param createDocumentationPartRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateDocumentationPartRequest.Builder} to create
* a request. Creates a new documentation part of a given API.
* @return Result of the CreateDocumentationPart operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateDocumentationPart
*/
default CreateDocumentationPartResponse createDocumentationPart(
Consumer createDocumentationPartRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return createDocumentationPart(CreateDocumentationPartRequest.builder().applyMutation(createDocumentationPartRequest)
.build());
}
/**
*
* Creates a documentation version
*
*
* @param createDocumentationVersionRequest
* Creates a new documentation version of a given API.
* @return Result of the CreateDocumentationVersion operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateDocumentationVersion
*/
default CreateDocumentationVersionResponse createDocumentationVersion(
CreateDocumentationVersionRequest createDocumentationVersionRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a documentation version
*
*
*
* This is a convenience which creates an instance of the {@link CreateDocumentationVersionRequest.Builder} avoiding
* the need to create one manually via {@link CreateDocumentationVersionRequest#builder()}
*
*
* @param createDocumentationVersionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateDocumentationVersionRequest.Builder} to
* create a request. Creates a new documentation version of a given API.
* @return Result of the CreateDocumentationVersion operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateDocumentationVersion
*/
default CreateDocumentationVersionResponse createDocumentationVersion(
Consumer createDocumentationVersionRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return createDocumentationVersion(CreateDocumentationVersionRequest.builder()
.applyMutation(createDocumentationVersionRequest).build());
}
/**
*
* Creates a new domain name.
*
*
* @param createDomainNameRequest
* A request to create a new domain name.
* @return Result of the CreateDomainName operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateDomainName
*/
default CreateDomainNameResponse createDomainName(CreateDomainNameRequest createDomainNameRequest)
throws BadRequestException, ConflictException, LimitExceededException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new domain name.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDomainNameRequest.Builder} avoiding the need
* to create one manually via {@link CreateDomainNameRequest#builder()}
*
*
* @param createDomainNameRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateDomainNameRequest.Builder} to create a
* request. A request to create a new domain name.
* @return Result of the CreateDomainName operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateDomainName
*/
default CreateDomainNameResponse createDomainName(Consumer createDomainNameRequest)
throws BadRequestException, ConflictException, LimitExceededException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return createDomainName(CreateDomainNameRequest.builder().applyMutation(createDomainNameRequest).build());
}
/**
*
* Adds a new Model resource to an existing RestApi resource.
*
*
* @param createModelRequest
* Request to add a new Model to an existing RestApi resource.
* @return Result of the CreateModel operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateModel
*/
default CreateModelResponse createModel(CreateModelRequest createModelRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Adds a new Model resource to an existing RestApi resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateModelRequest.Builder} avoiding the need to
* create one manually via {@link CreateModelRequest#builder()}
*
*
* @param createModelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateModelRequest.Builder} to create a request.
* Request to add a new Model to an existing RestApi resource.
* @return Result of the CreateModel operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateModel
*/
default CreateModelResponse createModel(Consumer createModelRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return createModel(CreateModelRequest.builder().applyMutation(createModelRequest).build());
}
/**
*
* Creates a RequestValidator of a given RestApi.
*
*
* @param createRequestValidatorRequest
* Creates a RequestValidator of a given RestApi.
* @return Result of the CreateRequestValidator operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateRequestValidator
*/
default CreateRequestValidatorResponse createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a RequestValidator of a given RestApi.
*
*
*
* This is a convenience which creates an instance of the {@link CreateRequestValidatorRequest.Builder} avoiding the
* need to create one manually via {@link CreateRequestValidatorRequest#builder()}
*
*
* @param createRequestValidatorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateRequestValidatorRequest.Builder} to create a
* request. Creates a RequestValidator of a given RestApi.
* @return Result of the CreateRequestValidator operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateRequestValidator
*/
default CreateRequestValidatorResponse createRequestValidator(
Consumer createRequestValidatorRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return createRequestValidator(CreateRequestValidatorRequest.builder().applyMutation(createRequestValidatorRequest)
.build());
}
/**
*
* Creates a Resource resource.
*
*
* @param createResourceRequest
* Requests API Gateway to create a Resource resource.
* @return Result of the CreateResource operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateResource
*/
default CreateResourceResponse createResource(CreateResourceRequest createResourceRequest) throws UnauthorizedException,
NotFoundException, ConflictException, LimitExceededException, BadRequestException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a Resource resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateResourceRequest.Builder} avoiding the need to
* create one manually via {@link CreateResourceRequest#builder()}
*
*
* @param createResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateResourceRequest.Builder} to create a
* request. Requests API Gateway to create a Resource resource.
* @return Result of the CreateResource operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateResource
*/
default CreateResourceResponse createResource(Consumer createResourceRequest)
throws UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, BadRequestException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return createResource(CreateResourceRequest.builder().applyMutation(createResourceRequest).build());
}
/**
*
* Creates a new RestApi resource.
*
*
* @param createRestApiRequest
* The POST Request to add a new RestApi resource to your collection.
* @return Result of the CreateRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateRestApi
*/
default CreateRestApiResponse createRestApi(CreateRestApiRequest createRestApiRequest) throws BadRequestException,
ConflictException, LimitExceededException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new RestApi resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateRestApiRequest.Builder} avoiding the need to
* create one manually via {@link CreateRestApiRequest#builder()}
*
*
* @param createRestApiRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateRestApiRequest.Builder} to create a request.
* The POST Request to add a new RestApi resource to your collection.
* @return Result of the CreateRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateRestApi
*/
default CreateRestApiResponse createRestApi(Consumer createRestApiRequest)
throws BadRequestException, ConflictException, LimitExceededException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return createRestApi(CreateRestApiRequest.builder().applyMutation(createRestApiRequest).build());
}
/**
*
* Creates a new Stage resource that references a pre-existing Deployment for the API.
*
*
* @param createStageRequest
* Requests API Gateway to create a Stage resource.
* @return Result of the CreateStage operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateStage
*/
default CreateStageResponse createStage(CreateStageRequest createStageRequest) throws UnauthorizedException,
BadRequestException, NotFoundException, ConflictException, LimitExceededException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new Stage resource that references a pre-existing Deployment for the API.
*
*
*
* This is a convenience which creates an instance of the {@link CreateStageRequest.Builder} avoiding the need to
* create one manually via {@link CreateStageRequest#builder()}
*
*
* @param createStageRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateStageRequest.Builder} to create a request.
* Requests API Gateway to create a Stage resource.
* @return Result of the CreateStage operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateStage
*/
default CreateStageResponse createStage(Consumer createStageRequest)
throws UnauthorizedException, BadRequestException, NotFoundException, ConflictException, LimitExceededException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return createStage(CreateStageRequest.builder().applyMutation(createStageRequest).build());
}
/**
*
* Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the
* payload.
*
*
* @param createUsagePlanRequest
* The POST request to create a usage plan with the name, description, throttle limits and quota limits, as
* well as the associated API stages, specified in the payload.
* @return Result of the CreateUsagePlan operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateUsagePlan
*/
default CreateUsagePlanResponse createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the
* payload.
*
*
*
* This is a convenience which creates an instance of the {@link CreateUsagePlanRequest.Builder} avoiding the need
* to create one manually via {@link CreateUsagePlanRequest#builder()}
*
*
* @param createUsagePlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateUsagePlanRequest.Builder} to create a
* request. The POST request to create a usage plan with the name, description, throttle limits and quota
* limits, as well as the associated API stages, specified in the payload.
* @return Result of the CreateUsagePlan operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateUsagePlan
*/
default CreateUsagePlanResponse createUsagePlan(Consumer createUsagePlanRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return createUsagePlan(CreateUsagePlanRequest.builder().applyMutation(createUsagePlanRequest).build());
}
/**
*
* Creates a usage plan key for adding an existing API key to a usage plan.
*
*
* @param createUsagePlanKeyRequest
* The POST request to create a usage plan key for adding an existing API key to a usage plan.
* @return Result of the CreateUsagePlanKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateUsagePlanKey
*/
default CreateUsagePlanKeyResponse createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a usage plan key for adding an existing API key to a usage plan.
*
*
*
* This is a convenience which creates an instance of the {@link CreateUsagePlanKeyRequest.Builder} avoiding the
* need to create one manually via {@link CreateUsagePlanKeyRequest#builder()}
*
*
* @param createUsagePlanKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateUsagePlanKeyRequest.Builder} to create a
* request. The POST request to create a usage plan key for adding an existing API key to a usage plan.
* @return Result of the CreateUsagePlanKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateUsagePlanKey
*/
default CreateUsagePlanKeyResponse createUsagePlanKey(Consumer createUsagePlanKeyRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return createUsagePlanKey(CreateUsagePlanKeyRequest.builder().applyMutation(createUsagePlanKeyRequest).build());
}
/**
*
* Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically
* takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC
* Endpoint services.
*
*
* @param createVpcLinkRequest
* Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that
* typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create
* and update VPC Endpoint services.
* @return Result of the CreateVpcLink operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateVpcLink
*/
default CreateVpcLinkResponse createVpcLink(CreateVpcLinkRequest createVpcLinkRequest) throws BadRequestException,
ConflictException, LimitExceededException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically
* takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC
* Endpoint services.
*
*
*
* This is a convenience which creates an instance of the {@link CreateVpcLinkRequest.Builder} avoiding the need to
* create one manually via {@link CreateVpcLinkRequest#builder()}
*
*
* @param createVpcLinkRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateVpcLinkRequest.Builder} to create a request.
* Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that
* typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create
* and update VPC Endpoint services.
* @return Result of the CreateVpcLink operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.CreateVpcLink
*/
default CreateVpcLinkResponse createVpcLink(Consumer createVpcLinkRequest)
throws BadRequestException, ConflictException, LimitExceededException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return createVpcLink(CreateVpcLinkRequest.builder().applyMutation(createVpcLinkRequest).build());
}
/**
*
* Deletes the ApiKey resource.
*
*
* @param deleteApiKeyRequest
* A request to delete the ApiKey resource.
* @return Result of the DeleteApiKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteApiKey
*/
default DeleteApiKeyResponse deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest) throws BadRequestException,
ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the ApiKey resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteApiKeyRequest.Builder} avoiding the need to
* create one manually via {@link DeleteApiKeyRequest#builder()}
*
*
* @param deleteApiKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteApiKeyRequest.Builder} to create a request.
* A request to delete the ApiKey resource.
* @return Result of the DeleteApiKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteApiKey
*/
default DeleteApiKeyResponse deleteApiKey(Consumer deleteApiKeyRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return deleteApiKey(DeleteApiKeyRequest.builder().applyMutation(deleteApiKeyRequest).build());
}
/**
*
* Deletes an existing Authorizer resource.
*
*
* @param deleteAuthorizerRequest
* Request to delete an existing Authorizer resource.
* @return Result of the DeleteAuthorizer operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteAuthorizer
*/
default DeleteAuthorizerResponse deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an existing Authorizer resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteAuthorizerRequest.Builder} avoiding the need
* to create one manually via {@link DeleteAuthorizerRequest#builder()}
*
*
* @param deleteAuthorizerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteAuthorizerRequest.Builder} to create a
* request. Request to delete an existing Authorizer resource.
* @return Result of the DeleteAuthorizer operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteAuthorizer
*/
default DeleteAuthorizerResponse deleteAuthorizer(Consumer deleteAuthorizerRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return deleteAuthorizer(DeleteAuthorizerRequest.builder().applyMutation(deleteAuthorizerRequest).build());
}
/**
*
* Deletes the BasePathMapping resource.
*
*
* @param deleteBasePathMappingRequest
* A request to delete the BasePathMapping resource.
* @return Result of the DeleteBasePathMapping operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteBasePathMapping
*/
default DeleteBasePathMappingResponse deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the BasePathMapping resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBasePathMappingRequest.Builder} avoiding the
* need to create one manually via {@link DeleteBasePathMappingRequest#builder()}
*
*
* @param deleteBasePathMappingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteBasePathMappingRequest.Builder} to create a
* request. A request to delete the BasePathMapping resource.
* @return Result of the DeleteBasePathMapping operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteBasePathMapping
*/
default DeleteBasePathMappingResponse deleteBasePathMapping(
Consumer deleteBasePathMappingRequest) throws BadRequestException,
ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return deleteBasePathMapping(DeleteBasePathMappingRequest.builder().applyMutation(deleteBasePathMappingRequest).build());
}
/**
*
* Deletes the ClientCertificate resource.
*
*
* @param deleteClientCertificateRequest
* A request to delete the ClientCertificate resource.
* @return Result of the DeleteClientCertificate operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteClientCertificate
*/
default DeleteClientCertificateResponse deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the ClientCertificate resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteClientCertificateRequest.Builder} avoiding
* the need to create one manually via {@link DeleteClientCertificateRequest#builder()}
*
*
* @param deleteClientCertificateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteClientCertificateRequest.Builder} to create
* a request. A request to delete the ClientCertificate resource.
* @return Result of the DeleteClientCertificate operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteClientCertificate
*/
default DeleteClientCertificateResponse deleteClientCertificate(
Consumer deleteClientCertificateRequest) throws BadRequestException,
ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return deleteClientCertificate(DeleteClientCertificateRequest.builder().applyMutation(deleteClientCertificateRequest)
.build());
}
/**
*
* Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated
* with it.
*
*
* @param deleteDeploymentRequest
* Requests API Gateway to delete a Deployment resource.
* @return Result of the DeleteDeployment operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteDeployment
*/
default DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated
* with it.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDeploymentRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDeploymentRequest#builder()}
*
*
* @param deleteDeploymentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteDeploymentRequest.Builder} to create a
* request. Requests API Gateway to delete a Deployment resource.
* @return Result of the DeleteDeployment operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteDeployment
*/
default DeleteDeploymentResponse deleteDeployment(Consumer deleteDeploymentRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return deleteDeployment(DeleteDeploymentRequest.builder().applyMutation(deleteDeploymentRequest).build());
}
/**
*
* Deletes a documentation part
*
*
* @param deleteDocumentationPartRequest
* Deletes an existing documentation part of an API.
* @return Result of the DeleteDocumentationPart operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteDocumentationPart
*/
default DeleteDocumentationPartResponse deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a documentation part
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDocumentationPartRequest.Builder} avoiding
* the need to create one manually via {@link DeleteDocumentationPartRequest#builder()}
*
*
* @param deleteDocumentationPartRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteDocumentationPartRequest.Builder} to create
* a request. Deletes an existing documentation part of an API.
* @return Result of the DeleteDocumentationPart operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteDocumentationPart
*/
default DeleteDocumentationPartResponse deleteDocumentationPart(
Consumer deleteDocumentationPartRequest) throws BadRequestException,
ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return deleteDocumentationPart(DeleteDocumentationPartRequest.builder().applyMutation(deleteDocumentationPartRequest)
.build());
}
/**
*
* Deletes a documentation version.
*
*
* @param deleteDocumentationVersionRequest
* Deletes an existing documentation version of an API.
* @return Result of the DeleteDocumentationVersion operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteDocumentationVersion
*/
default DeleteDocumentationVersionResponse deleteDocumentationVersion(
DeleteDocumentationVersionRequest deleteDocumentationVersionRequest) throws BadRequestException, ConflictException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a documentation version.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDocumentationVersionRequest.Builder} avoiding
* the need to create one manually via {@link DeleteDocumentationVersionRequest#builder()}
*
*
* @param deleteDocumentationVersionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteDocumentationVersionRequest.Builder} to
* create a request. Deletes an existing documentation version of an API.
* @return Result of the DeleteDocumentationVersion operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteDocumentationVersion
*/
default DeleteDocumentationVersionResponse deleteDocumentationVersion(
Consumer deleteDocumentationVersionRequest) throws BadRequestException,
ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return deleteDocumentationVersion(DeleteDocumentationVersionRequest.builder()
.applyMutation(deleteDocumentationVersionRequest).build());
}
/**
*
* Deletes the DomainName resource.
*
*
* @param deleteDomainNameRequest
* A request to delete the DomainName resource.
* @return Result of the DeleteDomainName operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteDomainName
*/
default DeleteDomainNameResponse deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the DomainName resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDomainNameRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDomainNameRequest#builder()}
*
*
* @param deleteDomainNameRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteDomainNameRequest.Builder} to create a
* request. A request to delete the DomainName resource.
* @return Result of the DeleteDomainName operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteDomainName
*/
default DeleteDomainNameResponse deleteDomainName(Consumer deleteDomainNameRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return deleteDomainName(DeleteDomainNameRequest.builder().applyMutation(deleteDomainNameRequest).build());
}
/**
*
* Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it
* with the default settings.
*
*
* @param deleteGatewayResponseRequest
* Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets
* it with the default settings.
* @return Result of the DeleteGatewayResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteGatewayResponse
*/
default DeleteGatewayResponseResponse deleteGatewayResponse(DeleteGatewayResponseRequest deleteGatewayResponseRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it
* with the default settings.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteGatewayResponseRequest.Builder} avoiding the
* need to create one manually via {@link DeleteGatewayResponseRequest#builder()}
*
*
* @param deleteGatewayResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteGatewayResponseRequest.Builder} to create a
* request. Clears any customization of a GatewayResponse of a specified response type on the given RestApi
* and resets it with the default settings.
* @return Result of the DeleteGatewayResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteGatewayResponse
*/
default DeleteGatewayResponseResponse deleteGatewayResponse(
Consumer deleteGatewayResponseRequest) throws BadRequestException,
ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return deleteGatewayResponse(DeleteGatewayResponseRequest.builder().applyMutation(deleteGatewayResponseRequest).build());
}
/**
*
* Represents a delete integration.
*
*
* @param deleteIntegrationRequest
* Represents a delete integration request.
* @return Result of the DeleteIntegration operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteIntegration
*/
default DeleteIntegrationResponse deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Represents a delete integration.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteIntegrationRequest.Builder} avoiding the need
* to create one manually via {@link DeleteIntegrationRequest#builder()}
*
*
* @param deleteIntegrationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteIntegrationRequest.Builder} to create a
* request. Represents a delete integration request.
* @return Result of the DeleteIntegration operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteIntegration
*/
default DeleteIntegrationResponse deleteIntegration(Consumer deleteIntegrationRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return deleteIntegration(DeleteIntegrationRequest.builder().applyMutation(deleteIntegrationRequest).build());
}
/**
*
* Represents a delete integration response.
*
*
* @param deleteIntegrationResponseRequest
* Represents a delete integration response request.
* @return Result of the DeleteIntegrationResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteIntegrationResponse
*/
default DeleteIntegrationResponseResponse deleteIntegrationResponse(
DeleteIntegrationResponseRequest deleteIntegrationResponseRequest) throws BadRequestException, ConflictException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Represents a delete integration response.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteIntegrationResponseRequest.Builder} avoiding
* the need to create one manually via {@link DeleteIntegrationResponseRequest#builder()}
*
*
* @param deleteIntegrationResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteIntegrationResponseRequest.Builder} to
* create a request. Represents a delete integration response request.
* @return Result of the DeleteIntegrationResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteIntegrationResponse
*/
default DeleteIntegrationResponseResponse deleteIntegrationResponse(
Consumer deleteIntegrationResponseRequest) throws BadRequestException,
ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return deleteIntegrationResponse(DeleteIntegrationResponseRequest.builder()
.applyMutation(deleteIntegrationResponseRequest).build());
}
/**
*
* Deletes an existing Method resource.
*
*
* @param deleteMethodRequest
* Request to delete an existing Method resource.
* @return Result of the DeleteMethod operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteMethod
*/
default DeleteMethodResponse deleteMethod(DeleteMethodRequest deleteMethodRequest) throws UnauthorizedException,
NotFoundException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an existing Method resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteMethodRequest.Builder} avoiding the need to
* create one manually via {@link DeleteMethodRequest#builder()}
*
*
* @param deleteMethodRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteMethodRequest.Builder} to create a request.
* Request to delete an existing Method resource.
* @return Result of the DeleteMethod operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteMethod
*/
default DeleteMethodResponse deleteMethod(Consumer deleteMethodRequest)
throws UnauthorizedException, NotFoundException, TooManyRequestsException, ConflictException, AwsServiceException,
SdkClientException, ApiGatewayException {
return deleteMethod(DeleteMethodRequest.builder().applyMutation(deleteMethodRequest).build());
}
/**
*
* Deletes an existing MethodResponse resource.
*
*
* @param deleteMethodResponseRequest
* A request to delete an existing MethodResponse resource.
* @return Result of the DeleteMethodResponse operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteMethodResponse
*/
default DeleteMethodResponseResponse deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, ConflictException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an existing MethodResponse resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteMethodResponseRequest.Builder} avoiding the
* need to create one manually via {@link DeleteMethodResponseRequest#builder()}
*
*
* @param deleteMethodResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteMethodResponseRequest.Builder} to create a
* request. A request to delete an existing MethodResponse resource.
* @return Result of the DeleteMethodResponse operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteMethodResponse
*/
default DeleteMethodResponseResponse deleteMethodResponse(
Consumer deleteMethodResponseRequest) throws UnauthorizedException,
NotFoundException, TooManyRequestsException, BadRequestException, ConflictException, AwsServiceException,
SdkClientException, ApiGatewayException {
return deleteMethodResponse(DeleteMethodResponseRequest.builder().applyMutation(deleteMethodResponseRequest).build());
}
/**
*
* Deletes a model.
*
*
* @param deleteModelRequest
* Request to delete an existing model in an existing RestApi resource.
* @return Result of the DeleteModel operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteModel
*/
default DeleteModelResponse deleteModel(DeleteModelRequest deleteModelRequest) throws BadRequestException, ConflictException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a model.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteModelRequest.Builder} avoiding the need to
* create one manually via {@link DeleteModelRequest#builder()}
*
*
* @param deleteModelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteModelRequest.Builder} to create a request.
* Request to delete an existing model in an existing RestApi resource.
* @return Result of the DeleteModel operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteModel
*/
default DeleteModelResponse deleteModel(Consumer deleteModelRequest) throws BadRequestException,
ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return deleteModel(DeleteModelRequest.builder().applyMutation(deleteModelRequest).build());
}
/**
*
* Deletes a RequestValidator of a given RestApi.
*
*
* @param deleteRequestValidatorRequest
* Deletes a specified RequestValidator of a given RestApi.
* @return Result of the DeleteRequestValidator operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteRequestValidator
*/
default DeleteRequestValidatorResponse deleteRequestValidator(DeleteRequestValidatorRequest deleteRequestValidatorRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a RequestValidator of a given RestApi.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteRequestValidatorRequest.Builder} avoiding the
* need to create one manually via {@link DeleteRequestValidatorRequest#builder()}
*
*
* @param deleteRequestValidatorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteRequestValidatorRequest.Builder} to create a
* request. Deletes a specified RequestValidator of a given RestApi.
* @return Result of the DeleteRequestValidator operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteRequestValidator
*/
default DeleteRequestValidatorResponse deleteRequestValidator(
Consumer deleteRequestValidatorRequest) throws BadRequestException,
ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return deleteRequestValidator(DeleteRequestValidatorRequest.builder().applyMutation(deleteRequestValidatorRequest)
.build());
}
/**
*
* Deletes a Resource resource.
*
*
* @param deleteResourceRequest
* Request to delete a Resource.
* @return Result of the DeleteResource operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteResource
*/
default DeleteResourceResponse deleteResource(DeleteResourceRequest deleteResourceRequest) throws UnauthorizedException,
NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a Resource resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteResourceRequest.Builder} avoiding the need to
* create one manually via {@link DeleteResourceRequest#builder()}
*
*
* @param deleteResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteResourceRequest.Builder} to create a
* request. Request to delete a Resource.
* @return Result of the DeleteResource operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteResource
*/
default DeleteResourceResponse deleteResource(Consumer deleteResourceRequest)
throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return deleteResource(DeleteResourceRequest.builder().applyMutation(deleteResourceRequest).build());
}
/**
*
* Deletes the specified API.
*
*
* @param deleteRestApiRequest
* Request to delete the specified API from your collection.
* @return Result of the DeleteRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteRestApi
*/
default DeleteRestApiResponse deleteRestApi(DeleteRestApiRequest deleteRestApiRequest) throws BadRequestException,
ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified API.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteRestApiRequest.Builder} avoiding the need to
* create one manually via {@link DeleteRestApiRequest#builder()}
*
*
* @param deleteRestApiRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteRestApiRequest.Builder} to create a request.
* Request to delete the specified API from your collection.
* @return Result of the DeleteRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteRestApi
*/
default DeleteRestApiResponse deleteRestApi(Consumer deleteRestApiRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return deleteRestApi(DeleteRestApiRequest.builder().applyMutation(deleteRestApiRequest).build());
}
/**
*
* Deletes a Stage resource.
*
*
* @param deleteStageRequest
* Requests API Gateway to delete a Stage resource.
* @return Result of the DeleteStage operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteStage
*/
default DeleteStageResponse deleteStage(DeleteStageRequest deleteStageRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a Stage resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteStageRequest.Builder} avoiding the need to
* create one manually via {@link DeleteStageRequest#builder()}
*
*
* @param deleteStageRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteStageRequest.Builder} to create a request.
* Requests API Gateway to delete a Stage resource.
* @return Result of the DeleteStage operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteStage
*/
default DeleteStageResponse deleteStage(Consumer deleteStageRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return deleteStage(DeleteStageRequest.builder().applyMutation(deleteStageRequest).build());
}
/**
*
* Deletes a usage plan of a given plan Id.
*
*
* @param deleteUsagePlanRequest
* The DELETE request to delete a usage plan of a given plan Id.
* @return Result of the DeleteUsagePlan operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteUsagePlan
*/
default DeleteUsagePlanResponse deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest) throws BadRequestException,
ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a usage plan of a given plan Id.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteUsagePlanRequest.Builder} avoiding the need
* to create one manually via {@link DeleteUsagePlanRequest#builder()}
*
*
* @param deleteUsagePlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteUsagePlanRequest.Builder} to create a
* request. The DELETE request to delete a usage plan of a given plan Id.
* @return Result of the DeleteUsagePlan operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteUsagePlan
*/
default DeleteUsagePlanResponse deleteUsagePlan(Consumer deleteUsagePlanRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return deleteUsagePlan(DeleteUsagePlanRequest.builder().applyMutation(deleteUsagePlanRequest).build());
}
/**
*
* Deletes a usage plan key and remove the underlying API key from the associated usage plan.
*
*
* @param deleteUsagePlanKeyRequest
* The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage
* plan.
* @return Result of the DeleteUsagePlanKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteUsagePlanKey
*/
default DeleteUsagePlanKeyResponse deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a usage plan key and remove the underlying API key from the associated usage plan.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteUsagePlanKeyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteUsagePlanKeyRequest#builder()}
*
*
* @param deleteUsagePlanKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteUsagePlanKeyRequest.Builder} to create a
* request. The DELETE request to delete a usage plan key and remove the underlying API key from the
* associated usage plan.
* @return Result of the DeleteUsagePlanKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteUsagePlanKey
*/
default DeleteUsagePlanKeyResponse deleteUsagePlanKey(Consumer deleteUsagePlanKeyRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return deleteUsagePlanKey(DeleteUsagePlanKeyRequest.builder().applyMutation(deleteUsagePlanKeyRequest).build());
}
/**
*
* Deletes an existing VpcLink of a specified identifier.
*
*
* @param deleteVpcLinkRequest
* Deletes an existing VpcLink of a specified identifier.
* @return Result of the DeleteVpcLink operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteVpcLink
*/
default DeleteVpcLinkResponse deleteVpcLink(DeleteVpcLinkRequest deleteVpcLinkRequest) throws BadRequestException,
ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an existing VpcLink of a specified identifier.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteVpcLinkRequest.Builder} avoiding the need to
* create one manually via {@link DeleteVpcLinkRequest#builder()}
*
*
* @param deleteVpcLinkRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteVpcLinkRequest.Builder} to create a request.
* Deletes an existing VpcLink of a specified identifier.
* @return Result of the DeleteVpcLink operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.DeleteVpcLink
*/
default DeleteVpcLinkResponse deleteVpcLink(Consumer deleteVpcLinkRequest)
throws BadRequestException, ConflictException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return deleteVpcLink(DeleteVpcLinkRequest.builder().applyMutation(deleteVpcLinkRequest).build());
}
/**
*
* Flushes all authorizer cache entries on a stage.
*
*
* @param flushStageAuthorizersCacheRequest
* Request to flush authorizer cache entries on a specified stage.
* @return Result of the FlushStageAuthorizersCache operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.FlushStageAuthorizersCache
*/
default FlushStageAuthorizersCacheResponse flushStageAuthorizersCache(
FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Flushes all authorizer cache entries on a stage.
*
*
*
* This is a convenience which creates an instance of the {@link FlushStageAuthorizersCacheRequest.Builder} avoiding
* the need to create one manually via {@link FlushStageAuthorizersCacheRequest#builder()}
*
*
* @param flushStageAuthorizersCacheRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.FlushStageAuthorizersCacheRequest.Builder} to
* create a request. Request to flush authorizer cache entries on a specified stage.
* @return Result of the FlushStageAuthorizersCache operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.FlushStageAuthorizersCache
*/
default FlushStageAuthorizersCacheResponse flushStageAuthorizersCache(
Consumer flushStageAuthorizersCacheRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest.builder()
.applyMutation(flushStageAuthorizersCacheRequest).build());
}
/**
*
* Flushes a stage's cache.
*
*
* @param flushStageCacheRequest
* Requests API Gateway to flush a stage's cache.
* @return Result of the FlushStageCache operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.FlushStageCache
*/
default FlushStageCacheResponse flushStageCache(FlushStageCacheRequest flushStageCacheRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Flushes a stage's cache.
*
*
*
* This is a convenience which creates an instance of the {@link FlushStageCacheRequest.Builder} avoiding the need
* to create one manually via {@link FlushStageCacheRequest#builder()}
*
*
* @param flushStageCacheRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.FlushStageCacheRequest.Builder} to create a
* request. Requests API Gateway to flush a stage's cache.
* @return Result of the FlushStageCache operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.FlushStageCache
*/
default FlushStageCacheResponse flushStageCache(Consumer flushStageCacheRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return flushStageCache(FlushStageCacheRequest.builder().applyMutation(flushStageCacheRequest).build());
}
/**
*
* Generates a ClientCertificate resource.
*
*
* @param generateClientCertificateRequest
* A request to generate a ClientCertificate resource.
* @return Result of the GenerateClientCertificate operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GenerateClientCertificate
*/
default GenerateClientCertificateResponse generateClientCertificate(
GenerateClientCertificateRequest generateClientCertificateRequest) throws BadRequestException, ConflictException,
LimitExceededException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Generates a ClientCertificate resource.
*
*
*
* This is a convenience which creates an instance of the {@link GenerateClientCertificateRequest.Builder} avoiding
* the need to create one manually via {@link GenerateClientCertificateRequest#builder()}
*
*
* @param generateClientCertificateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GenerateClientCertificateRequest.Builder} to
* create a request. A request to generate a ClientCertificate resource.
* @return Result of the GenerateClientCertificate operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GenerateClientCertificate
*/
default GenerateClientCertificateResponse generateClientCertificate(
Consumer generateClientCertificateRequest) throws BadRequestException,
ConflictException, LimitExceededException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return generateClientCertificate(GenerateClientCertificateRequest.builder()
.applyMutation(generateClientCertificateRequest).build());
}
/**
*
* Generates a ClientCertificate resource.
*
*
* @return Result of the GenerateClientCertificate operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GenerateClientCertificate
* @see #generateClientCertificate(GenerateClientCertificateRequest)
*/
default GenerateClientCertificateResponse generateClientCertificate() throws BadRequestException, ConflictException,
LimitExceededException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return generateClientCertificate(GenerateClientCertificateRequest.builder().build());
}
/**
*
* Gets information about the current Account resource.
*
*
* @param getAccountRequest
* Requests API Gateway to get information about the current Account resource.
* @return Result of the GetAccount operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetAccount
*/
default GetAccountResponse getAccount(GetAccountRequest getAccountRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about the current Account resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetAccountRequest.Builder} avoiding the need to
* create one manually via {@link GetAccountRequest#builder()}
*
*
* @param getAccountRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetAccountRequest.Builder} to create a request.
* Requests API Gateway to get information about the current Account resource.
* @return Result of the GetAccount operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetAccount
*/
default GetAccountResponse getAccount(Consumer getAccountRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getAccount(GetAccountRequest.builder().applyMutation(getAccountRequest).build());
}
/**
*
* Gets information about the current Account resource.
*
*
* @return Result of the GetAccount operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetAccount
* @see #getAccount(GetAccountRequest)
*/
default GetAccountResponse getAccount() throws BadRequestException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getAccount(GetAccountRequest.builder().build());
}
/**
*
* Gets information about the current ApiKey resource.
*
*
* @param getApiKeyRequest
* A request to get information about the current ApiKey resource.
* @return Result of the GetApiKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetApiKey
*/
default GetApiKeyResponse getApiKey(GetApiKeyRequest getApiKeyRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about the current ApiKey resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetApiKeyRequest.Builder} avoiding the need to
* create one manually via {@link GetApiKeyRequest#builder()}
*
*
* @param getApiKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetApiKeyRequest.Builder} to create a request. A
* request to get information about the current ApiKey resource.
* @return Result of the GetApiKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetApiKey
*/
default GetApiKeyResponse getApiKey(Consumer getApiKeyRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getApiKey(GetApiKeyRequest.builder().applyMutation(getApiKeyRequest).build());
}
/**
*
* Gets information about the current ApiKeys resource.
*
*
* @param getApiKeysRequest
* A request to get information about the current ApiKeys resource.
* @return Result of the GetApiKeys operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetApiKeys
*/
default GetApiKeysResponse getApiKeys(GetApiKeysRequest getApiKeysRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about the current ApiKeys resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetApiKeysRequest.Builder} avoiding the need to
* create one manually via {@link GetApiKeysRequest#builder()}
*
*
* @param getApiKeysRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest.Builder} to create a request. A
* request to get information about the current ApiKeys resource.
* @return Result of the GetApiKeys operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetApiKeys
*/
default GetApiKeysResponse getApiKeys(Consumer getApiKeysRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getApiKeys(GetApiKeysRequest.builder().applyMutation(getApiKeysRequest).build());
}
/**
*
* Gets information about the current ApiKeys resource.
*
*
* @return Result of the GetApiKeys operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetApiKeys
* @see #getApiKeys(GetApiKeysRequest)
*/
default GetApiKeysResponse getApiKeys() throws BadRequestException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getApiKeys(GetApiKeysRequest.builder().build());
}
/**
*
* This is a variant of {@link #getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetApiKeys
* @see #getApiKeysPaginator(GetApiKeysRequest)
*/
default GetApiKeysIterable getApiKeysPaginator() throws BadRequestException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getApiKeysPaginator(GetApiKeysRequest.builder().build());
}
/**
*
* This is a variant of {@link #getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)} operation.
*
*
* @param getApiKeysRequest
* A request to get information about the current ApiKeys resource.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetApiKeys
*/
default GetApiKeysIterable getApiKeysPaginator(GetApiKeysRequest getApiKeysRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return new GetApiKeysIterable(this, getApiKeysRequest);
}
/**
*
* This is a variant of {@link #getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetApiKeysRequest.Builder} avoiding the need to
* create one manually via {@link GetApiKeysRequest#builder()}
*
*
* @param getApiKeysRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest.Builder} to create a request. A
* request to get information about the current ApiKeys resource.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetApiKeys
*/
default GetApiKeysIterable getApiKeysPaginator(Consumer getApiKeysRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getApiKeysPaginator(GetApiKeysRequest.builder().applyMutation(getApiKeysRequest).build());
}
/**
*
* Describe an existing Authorizer resource.
*
*
* @param getAuthorizerRequest
* Request to describe an existing Authorizer resource.
* @return Result of the GetAuthorizer operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetAuthorizer
*/
default GetAuthorizerResponse getAuthorizer(GetAuthorizerRequest getAuthorizerRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Describe an existing Authorizer resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetAuthorizerRequest.Builder} avoiding the need to
* create one manually via {@link GetAuthorizerRequest#builder()}
*
*
* @param getAuthorizerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetAuthorizerRequest.Builder} to create a request.
* Request to describe an existing Authorizer resource.
* @return Result of the GetAuthorizer operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetAuthorizer
*/
default GetAuthorizerResponse getAuthorizer(Consumer getAuthorizerRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getAuthorizer(GetAuthorizerRequest.builder().applyMutation(getAuthorizerRequest).build());
}
/**
*
* Describe an existing Authorizers resource.
*
*
* @param getAuthorizersRequest
* Request to describe an existing Authorizers resource.
* @return Result of the GetAuthorizers operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetAuthorizers
*/
default GetAuthorizersResponse getAuthorizers(GetAuthorizersRequest getAuthorizersRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Describe an existing Authorizers resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetAuthorizersRequest.Builder} avoiding the need to
* create one manually via {@link GetAuthorizersRequest#builder()}
*
*
* @param getAuthorizersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetAuthorizersRequest.Builder} to create a
* request. Request to describe an existing Authorizers resource.
* @return Result of the GetAuthorizers operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetAuthorizers
*/
default GetAuthorizersResponse getAuthorizers(Consumer getAuthorizersRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getAuthorizers(GetAuthorizersRequest.builder().applyMutation(getAuthorizersRequest).build());
}
/**
*
* Describe a BasePathMapping resource.
*
*
* @param getBasePathMappingRequest
* Request to describe a BasePathMapping resource.
* @return Result of the GetBasePathMapping operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetBasePathMapping
*/
default GetBasePathMappingResponse getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Describe a BasePathMapping resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetBasePathMappingRequest.Builder} avoiding the
* need to create one manually via {@link GetBasePathMappingRequest#builder()}
*
*
* @param getBasePathMappingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetBasePathMappingRequest.Builder} to create a
* request. Request to describe a BasePathMapping resource.
* @return Result of the GetBasePathMapping operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetBasePathMapping
*/
default GetBasePathMappingResponse getBasePathMapping(Consumer getBasePathMappingRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getBasePathMapping(GetBasePathMappingRequest.builder().applyMutation(getBasePathMappingRequest).build());
}
/**
*
* Represents a collection of BasePathMapping resources.
*
*
* @param getBasePathMappingsRequest
* A request to get information about a collection of BasePathMapping resources.
* @return Result of the GetBasePathMappings operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetBasePathMappings
*/
default GetBasePathMappingsResponse getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Represents a collection of BasePathMapping resources.
*
*
*
* This is a convenience which creates an instance of the {@link GetBasePathMappingsRequest.Builder} avoiding the
* need to create one manually via {@link GetBasePathMappingsRequest#builder()}
*
*
* @param getBasePathMappingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest.Builder} to create a
* request. A request to get information about a collection of BasePathMapping resources.
* @return Result of the GetBasePathMappings operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetBasePathMappings
*/
default GetBasePathMappingsResponse getBasePathMappings(
Consumer getBasePathMappingsRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getBasePathMappings(GetBasePathMappingsRequest.builder().applyMutation(getBasePathMappingsRequest).build());
}
/**
*
* This is a variant of
* {@link #getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsIterable responses = client.getBasePathMappingsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsIterable responses = client
* .getBasePathMappingsPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsIterable responses = client.getBasePathMappingsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)}
* operation.
*
*
* @param getBasePathMappingsRequest
* A request to get information about a collection of BasePathMapping resources.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetBasePathMappings
*/
default GetBasePathMappingsIterable getBasePathMappingsPaginator(GetBasePathMappingsRequest getBasePathMappingsRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return new GetBasePathMappingsIterable(this, getBasePathMappingsRequest);
}
/**
*
* This is a variant of
* {@link #getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsIterable responses = client.getBasePathMappingsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsIterable responses = client
* .getBasePathMappingsPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsIterable responses = client.getBasePathMappingsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetBasePathMappingsRequest.Builder} avoiding the
* need to create one manually via {@link GetBasePathMappingsRequest#builder()}
*
*
* @param getBasePathMappingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest.Builder} to create a
* request. A request to get information about a collection of BasePathMapping resources.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetBasePathMappings
*/
default GetBasePathMappingsIterable getBasePathMappingsPaginator(
Consumer getBasePathMappingsRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getBasePathMappingsPaginator(GetBasePathMappingsRequest.builder().applyMutation(getBasePathMappingsRequest)
.build());
}
/**
*
* Gets information about the current ClientCertificate resource.
*
*
* @param getClientCertificateRequest
* A request to get information about the current ClientCertificate resource.
* @return Result of the GetClientCertificate operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetClientCertificate
*/
default GetClientCertificateResponse getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about the current ClientCertificate resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetClientCertificateRequest.Builder} avoiding the
* need to create one manually via {@link GetClientCertificateRequest#builder()}
*
*
* @param getClientCertificateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetClientCertificateRequest.Builder} to create a
* request. A request to get information about the current ClientCertificate resource.
* @return Result of the GetClientCertificate operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetClientCertificate
*/
default GetClientCertificateResponse getClientCertificate(
Consumer getClientCertificateRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getClientCertificate(GetClientCertificateRequest.builder().applyMutation(getClientCertificateRequest).build());
}
/**
*
* Gets a collection of ClientCertificate resources.
*
*
* @param getClientCertificatesRequest
* A request to get information about a collection of ClientCertificate resources.
* @return Result of the GetClientCertificates operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetClientCertificates
*/
default GetClientCertificatesResponse getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets a collection of ClientCertificate resources.
*
*
*
* This is a convenience which creates an instance of the {@link GetClientCertificatesRequest.Builder} avoiding the
* need to create one manually via {@link GetClientCertificatesRequest#builder()}
*
*
* @param getClientCertificatesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest.Builder} to create a
* request. A request to get information about a collection of ClientCertificate resources.
* @return Result of the GetClientCertificates operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetClientCertificates
*/
default GetClientCertificatesResponse getClientCertificates(
Consumer getClientCertificatesRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getClientCertificates(GetClientCertificatesRequest.builder().applyMutation(getClientCertificatesRequest).build());
}
/**
*
* Gets a collection of ClientCertificate resources.
*
*
* @return Result of the GetClientCertificates operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetClientCertificates
* @see #getClientCertificates(GetClientCertificatesRequest)
*/
default GetClientCertificatesResponse getClientCertificates() throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getClientCertificates(GetClientCertificatesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client.getClientCertificatesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client
* .getClientCertificatesPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client.getClientCertificatesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetClientCertificates
* @see #getClientCertificatesPaginator(GetClientCertificatesRequest)
*/
default GetClientCertificatesIterable getClientCertificatesPaginator() throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getClientCertificatesPaginator(GetClientCertificatesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client.getClientCertificatesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client
* .getClientCertificatesPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client.getClientCertificatesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)}
* operation.
*
*
* @param getClientCertificatesRequest
* A request to get information about a collection of ClientCertificate resources.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetClientCertificates
*/
default GetClientCertificatesIterable getClientCertificatesPaginator(GetClientCertificatesRequest getClientCertificatesRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return new GetClientCertificatesIterable(this, getClientCertificatesRequest);
}
/**
*
* This is a variant of
* {@link #getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client.getClientCertificatesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client
* .getClientCertificatesPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client.getClientCertificatesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetClientCertificatesRequest.Builder} avoiding the
* need to create one manually via {@link GetClientCertificatesRequest#builder()}
*
*
* @param getClientCertificatesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest.Builder} to create a
* request. A request to get information about a collection of ClientCertificate resources.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetClientCertificates
*/
default GetClientCertificatesIterable getClientCertificatesPaginator(
Consumer getClientCertificatesRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getClientCertificatesPaginator(GetClientCertificatesRequest.builder().applyMutation(getClientCertificatesRequest)
.build());
}
/**
*
* Gets information about a Deployment resource.
*
*
* @param getDeploymentRequest
* Requests API Gateway to get information about a Deployment resource.
* @return Result of the GetDeployment operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ServiceUnavailableException
* The requested service is not available. For details see the accompanying error message. Retry after the
* specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDeployment
*/
default GetDeploymentResponse getDeployment(GetDeploymentRequest getDeploymentRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about a Deployment resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetDeploymentRequest.Builder} avoiding the need to
* create one manually via {@link GetDeploymentRequest#builder()}
*
*
* @param getDeploymentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDeploymentRequest.Builder} to create a request.
* Requests API Gateway to get information about a Deployment resource.
* @return Result of the GetDeployment operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ServiceUnavailableException
* The requested service is not available. For details see the accompanying error message. Retry after the
* specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDeployment
*/
default GetDeploymentResponse getDeployment(Consumer getDeploymentRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException,
ServiceUnavailableException, AwsServiceException, SdkClientException, ApiGatewayException {
return getDeployment(GetDeploymentRequest.builder().applyMutation(getDeploymentRequest).build());
}
/**
*
* Gets information about a Deployments collection.
*
*
* @param getDeploymentsRequest
* Requests API Gateway to get information about a Deployments collection.
* @return Result of the GetDeployments operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ServiceUnavailableException
* The requested service is not available. For details see the accompanying error message. Retry after the
* specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDeployments
*/
default GetDeploymentsResponse getDeployments(GetDeploymentsRequest getDeploymentsRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about a Deployments collection.
*
*
*
* This is a convenience which creates an instance of the {@link GetDeploymentsRequest.Builder} avoiding the need to
* create one manually via {@link GetDeploymentsRequest#builder()}
*
*
* @param getDeploymentsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest.Builder} to create a
* request. Requests API Gateway to get information about a Deployments collection.
* @return Result of the GetDeployments operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ServiceUnavailableException
* The requested service is not available. For details see the accompanying error message. Retry after the
* specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDeployments
*/
default GetDeploymentsResponse getDeployments(Consumer getDeploymentsRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException,
ServiceUnavailableException, AwsServiceException, SdkClientException, ApiGatewayException {
return getDeployments(GetDeploymentsRequest.builder().applyMutation(getDeploymentsRequest).build());
}
/**
*
* This is a variant of
* {@link #getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsIterable responses = client.getDeploymentsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsIterable responses = client
* .getDeploymentsPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsIterable responses = client.getDeploymentsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)} operation.
*
*
* @param getDeploymentsRequest
* Requests API Gateway to get information about a Deployments collection.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ServiceUnavailableException
* The requested service is not available. For details see the accompanying error message. Retry after the
* specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDeployments
*/
default GetDeploymentsIterable getDeploymentsPaginator(GetDeploymentsRequest getDeploymentsRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException,
ServiceUnavailableException, AwsServiceException, SdkClientException, ApiGatewayException {
return new GetDeploymentsIterable(this, getDeploymentsRequest);
}
/**
*
* This is a variant of
* {@link #getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsIterable responses = client.getDeploymentsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsIterable responses = client
* .getDeploymentsPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsIterable responses = client.getDeploymentsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetDeploymentsRequest.Builder} avoiding the need to
* create one manually via {@link GetDeploymentsRequest#builder()}
*
*
* @param getDeploymentsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest.Builder} to create a
* request. Requests API Gateway to get information about a Deployments collection.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ServiceUnavailableException
* The requested service is not available. For details see the accompanying error message. Retry after the
* specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDeployments
*/
default GetDeploymentsIterable getDeploymentsPaginator(Consumer getDeploymentsRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException,
ServiceUnavailableException, AwsServiceException, SdkClientException, ApiGatewayException {
return getDeploymentsPaginator(GetDeploymentsRequest.builder().applyMutation(getDeploymentsRequest).build());
}
/**
*
* Gets a documentation part.
*
*
* @param getDocumentationPartRequest
* Gets a specified documentation part of a given API.
* @return Result of the GetDocumentationPart operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDocumentationPart
*/
default GetDocumentationPartResponse getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets a documentation part.
*
*
*
* This is a convenience which creates an instance of the {@link GetDocumentationPartRequest.Builder} avoiding the
* need to create one manually via {@link GetDocumentationPartRequest#builder()}
*
*
* @param getDocumentationPartRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDocumentationPartRequest.Builder} to create a
* request. Gets a specified documentation part of a given API.
* @return Result of the GetDocumentationPart operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDocumentationPart
*/
default GetDocumentationPartResponse getDocumentationPart(
Consumer getDocumentationPartRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getDocumentationPart(GetDocumentationPartRequest.builder().applyMutation(getDocumentationPartRequest).build());
}
/**
*
* Gets documentation parts.
*
*
* @param getDocumentationPartsRequest
* Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API
* entities (targets).
* @return Result of the GetDocumentationParts operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDocumentationParts
*/
default GetDocumentationPartsResponse getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets documentation parts.
*
*
*
* This is a convenience which creates an instance of the {@link GetDocumentationPartsRequest.Builder} avoiding the
* need to create one manually via {@link GetDocumentationPartsRequest#builder()}
*
*
* @param getDocumentationPartsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDocumentationPartsRequest.Builder} to create a
* request. Gets the documentation parts of an API. The result may be filtered by the type, name, or path of
* API entities (targets).
* @return Result of the GetDocumentationParts operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDocumentationParts
*/
default GetDocumentationPartsResponse getDocumentationParts(
Consumer getDocumentationPartsRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getDocumentationParts(GetDocumentationPartsRequest.builder().applyMutation(getDocumentationPartsRequest).build());
}
/**
*
* Gets a documentation version.
*
*
* @param getDocumentationVersionRequest
* Gets a documentation snapshot of an API.
* @return Result of the GetDocumentationVersion operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDocumentationVersion
*/
default GetDocumentationVersionResponse getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)
throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets a documentation version.
*
*
*
* This is a convenience which creates an instance of the {@link GetDocumentationVersionRequest.Builder} avoiding
* the need to create one manually via {@link GetDocumentationVersionRequest#builder()}
*
*
* @param getDocumentationVersionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDocumentationVersionRequest.Builder} to create
* a request. Gets a documentation snapshot of an API.
* @return Result of the GetDocumentationVersion operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDocumentationVersion
*/
default GetDocumentationVersionResponse getDocumentationVersion(
Consumer getDocumentationVersionRequest) throws UnauthorizedException,
NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getDocumentationVersion(GetDocumentationVersionRequest.builder().applyMutation(getDocumentationVersionRequest)
.build());
}
/**
*
* Gets documentation versions.
*
*
* @param getDocumentationVersionsRequest
* Gets the documentation versions of an API.
* @return Result of the GetDocumentationVersions operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDocumentationVersions
*/
default GetDocumentationVersionsResponse getDocumentationVersions(
GetDocumentationVersionsRequest getDocumentationVersionsRequest) throws BadRequestException, UnauthorizedException,
NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets documentation versions.
*
*
*
* This is a convenience which creates an instance of the {@link GetDocumentationVersionsRequest.Builder} avoiding
* the need to create one manually via {@link GetDocumentationVersionsRequest#builder()}
*
*
* @param getDocumentationVersionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDocumentationVersionsRequest.Builder} to create
* a request. Gets the documentation versions of an API.
* @return Result of the GetDocumentationVersions operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDocumentationVersions
*/
default GetDocumentationVersionsResponse getDocumentationVersions(
Consumer getDocumentationVersionsRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getDocumentationVersions(GetDocumentationVersionsRequest.builder().applyMutation(getDocumentationVersionsRequest)
.build());
}
/**
*
* Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
*
*
* @param getDomainNameRequest
* Request to get the name of a DomainName resource.
* @return Result of the GetDomainName operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDomainName
*/
default GetDomainNameResponse getDomainName(GetDomainNameRequest getDomainNameRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
*
*
*
* This is a convenience which creates an instance of the {@link GetDomainNameRequest.Builder} avoiding the need to
* create one manually via {@link GetDomainNameRequest#builder()}
*
*
* @param getDomainNameRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDomainNameRequest.Builder} to create a request.
* Request to get the name of a DomainName resource.
* @return Result of the GetDomainName operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDomainName
*/
default GetDomainNameResponse getDomainName(Consumer getDomainNameRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getDomainName(GetDomainNameRequest.builder().applyMutation(getDomainNameRequest).build());
}
/**
*
* Represents a collection of DomainName resources.
*
*
* @param getDomainNamesRequest
* Request to describe a collection of DomainName resources.
* @return Result of the GetDomainNames operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDomainNames
*/
default GetDomainNamesResponse getDomainNames(GetDomainNamesRequest getDomainNamesRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Represents a collection of DomainName resources.
*
*
*
* This is a convenience which creates an instance of the {@link GetDomainNamesRequest.Builder} avoiding the need to
* create one manually via {@link GetDomainNamesRequest#builder()}
*
*
* @param getDomainNamesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest.Builder} to create a
* request. Request to describe a collection of DomainName resources.
* @return Result of the GetDomainNames operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDomainNames
*/
default GetDomainNamesResponse getDomainNames(Consumer getDomainNamesRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getDomainNames(GetDomainNamesRequest.builder().applyMutation(getDomainNamesRequest).build());
}
/**
*
* Represents a collection of DomainName resources.
*
*
* @return Result of the GetDomainNames operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDomainNames
* @see #getDomainNames(GetDomainNamesRequest)
*/
default GetDomainNamesResponse getDomainNames() throws BadRequestException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getDomainNames(GetDomainNamesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client.getDomainNamesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client
* .getDomainNamesPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client.getDomainNamesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDomainNames
* @see #getDomainNamesPaginator(GetDomainNamesRequest)
*/
default GetDomainNamesIterable getDomainNamesPaginator() throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getDomainNamesPaginator(GetDomainNamesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client.getDomainNamesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client
* .getDomainNamesPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client.getDomainNamesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)} operation.
*
*
* @param getDomainNamesRequest
* Request to describe a collection of DomainName resources.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDomainNames
*/
default GetDomainNamesIterable getDomainNamesPaginator(GetDomainNamesRequest getDomainNamesRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return new GetDomainNamesIterable(this, getDomainNamesRequest);
}
/**
*
* This is a variant of
* {@link #getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client.getDomainNamesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client
* .getDomainNamesPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client.getDomainNamesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetDomainNamesRequest.Builder} avoiding the need to
* create one manually via {@link GetDomainNamesRequest#builder()}
*
*
* @param getDomainNamesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest.Builder} to create a
* request. Request to describe a collection of DomainName resources.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetDomainNames
*/
default GetDomainNamesIterable getDomainNamesPaginator(Consumer getDomainNamesRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getDomainNamesPaginator(GetDomainNamesRequest.builder().applyMutation(getDomainNamesRequest).build());
}
/**
*
* Exports a deployed version of a RestApi in a specified format.
*
*
* @param getExportRequest
* Request a new export of a RestApi for a particular Stage.
* @return Result of the GetExport operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetExport
*/
default GetExportResponse getExport(GetExportRequest getExportRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Exports a deployed version of a RestApi in a specified format.
*
*
*
* This is a convenience which creates an instance of the {@link GetExportRequest.Builder} avoiding the need to
* create one manually via {@link GetExportRequest#builder()}
*
*
* @param getExportRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetExportRequest.Builder} to create a request.
* Request a new export of a RestApi for a particular Stage.
* @return Result of the GetExport operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetExport
*/
default GetExportResponse getExport(Consumer getExportRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return getExport(GetExportRequest.builder().applyMutation(getExportRequest).build());
}
/**
*
* Gets a GatewayResponse of a specified response type on the given RestApi.
*
*
* @param getGatewayResponseRequest
* Gets a GatewayResponse of a specified response type on the given RestApi.
* @return Result of the GetGatewayResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetGatewayResponse
*/
default GetGatewayResponseResponse getGatewayResponse(GetGatewayResponseRequest getGatewayResponseRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets a GatewayResponse of a specified response type on the given RestApi.
*
*
*
* This is a convenience which creates an instance of the {@link GetGatewayResponseRequest.Builder} avoiding the
* need to create one manually via {@link GetGatewayResponseRequest#builder()}
*
*
* @param getGatewayResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetGatewayResponseRequest.Builder} to create a
* request. Gets a GatewayResponse of a specified response type on the given RestApi.
* @return Result of the GetGatewayResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetGatewayResponse
*/
default GetGatewayResponseResponse getGatewayResponse(Consumer getGatewayResponseRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getGatewayResponse(GetGatewayResponseRequest.builder().applyMutation(getGatewayResponseRequest).build());
}
/**
*
* Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for
* gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the
* supported response types.
*
*
* @param getGatewayResponsesRequest
* Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any
* definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses
* collection for the supported response types.
* @return Result of the GetGatewayResponses operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetGatewayResponses
*/
default GetGatewayResponsesResponse getGatewayResponses(GetGatewayResponsesRequest getGatewayResponsesRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for
* gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the
* supported response types.
*
*
*
* This is a convenience which creates an instance of the {@link GetGatewayResponsesRequest.Builder} avoiding the
* need to create one manually via {@link GetGatewayResponsesRequest#builder()}
*
*
* @param getGatewayResponsesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetGatewayResponsesRequest.Builder} to create a
* request. Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any
* definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses
* collection for the supported response types.
* @return Result of the GetGatewayResponses operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetGatewayResponses
*/
default GetGatewayResponsesResponse getGatewayResponses(
Consumer getGatewayResponsesRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getGatewayResponses(GetGatewayResponsesRequest.builder().applyMutation(getGatewayResponsesRequest).build());
}
/**
*
* Get the integration settings.
*
*
* @param getIntegrationRequest
* Represents a request to get the integration configuration.
* @return Result of the GetIntegration operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetIntegration
*/
default GetIntegrationResponse getIntegration(GetIntegrationRequest getIntegrationRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Get the integration settings.
*
*
*
* This is a convenience which creates an instance of the {@link GetIntegrationRequest.Builder} avoiding the need to
* create one manually via {@link GetIntegrationRequest#builder()}
*
*
* @param getIntegrationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetIntegrationRequest.Builder} to create a
* request. Represents a request to get the integration configuration.
* @return Result of the GetIntegration operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetIntegration
*/
default GetIntegrationResponse getIntegration(Consumer getIntegrationRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getIntegration(GetIntegrationRequest.builder().applyMutation(getIntegrationRequest).build());
}
/**
*
* Represents a get integration response.
*
*
* @param getIntegrationResponseRequest
* Represents a get integration response request.
* @return Result of the GetIntegrationResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetIntegrationResponse
*/
default GetIntegrationResponseResponse getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Represents a get integration response.
*
*
*
* This is a convenience which creates an instance of the {@link GetIntegrationResponseRequest.Builder} avoiding the
* need to create one manually via {@link GetIntegrationResponseRequest#builder()}
*
*
* @param getIntegrationResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetIntegrationResponseRequest.Builder} to create a
* request. Represents a get integration response request.
* @return Result of the GetIntegrationResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetIntegrationResponse
*/
default GetIntegrationResponseResponse getIntegrationResponse(
Consumer getIntegrationResponseRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getIntegrationResponse(GetIntegrationResponseRequest.builder().applyMutation(getIntegrationResponseRequest)
.build());
}
/**
*
* Describe an existing Method resource.
*
*
* @param getMethodRequest
* Request to describe an existing Method resource.
* @return Result of the GetMethod operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetMethod
*/
default GetMethodResponse getMethod(GetMethodRequest getMethodRequest) throws UnauthorizedException, NotFoundException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Describe an existing Method resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetMethodRequest.Builder} avoiding the need to
* create one manually via {@link GetMethodRequest#builder()}
*
*
* @param getMethodRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetMethodRequest.Builder} to create a request.
* Request to describe an existing Method resource.
* @return Result of the GetMethod operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetMethod
*/
default GetMethodResponse getMethod(Consumer getMethodRequest) throws UnauthorizedException,
NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getMethod(GetMethodRequest.builder().applyMutation(getMethodRequest).build());
}
/**
*
* Describes a MethodResponse resource.
*
*
* @param getMethodResponseRequest
* Request to describe a MethodResponse resource.
* @return Result of the GetMethodResponse operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetMethodResponse
*/
default GetMethodResponseResponse getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Describes a MethodResponse resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetMethodResponseRequest.Builder} avoiding the need
* to create one manually via {@link GetMethodResponseRequest#builder()}
*
*
* @param getMethodResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetMethodResponseRequest.Builder} to create a
* request. Request to describe a MethodResponse resource.
* @return Result of the GetMethodResponse operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetMethodResponse
*/
default GetMethodResponseResponse getMethodResponse(Consumer getMethodResponseRequest)
throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getMethodResponse(GetMethodResponseRequest.builder().applyMutation(getMethodResponseRequest).build());
}
/**
*
* Describes an existing model defined for a RestApi resource.
*
*
* @param getModelRequest
* Request to list information about a model in an existing RestApi resource.
* @return Result of the GetModel operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetModel
*/
default GetModelResponse getModel(GetModelRequest getModelRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Describes an existing model defined for a RestApi resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetModelRequest.Builder} avoiding the need to
* create one manually via {@link GetModelRequest#builder()}
*
*
* @param getModelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetModelRequest.Builder} to create a request.
* Request to list information about a model in an existing RestApi resource.
* @return Result of the GetModel operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetModel
*/
default GetModelResponse getModel(Consumer getModelRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getModel(GetModelRequest.builder().applyMutation(getModelRequest).build());
}
/**
*
* Generates a sample mapping template that can be used to transform a payload into the structure of a model.
*
*
* @param getModelTemplateRequest
* Request to generate a sample mapping template used to transform the payload.
* @return Result of the GetModelTemplate operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetModelTemplate
*/
default GetModelTemplateResponse getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Generates a sample mapping template that can be used to transform a payload into the structure of a model.
*
*
*
* This is a convenience which creates an instance of the {@link GetModelTemplateRequest.Builder} avoiding the need
* to create one manually via {@link GetModelTemplateRequest#builder()}
*
*
* @param getModelTemplateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetModelTemplateRequest.Builder} to create a
* request. Request to generate a sample mapping template used to transform the payload.
* @return Result of the GetModelTemplate operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetModelTemplate
*/
default GetModelTemplateResponse getModelTemplate(Consumer getModelTemplateRequest)
throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getModelTemplate(GetModelTemplateRequest.builder().applyMutation(getModelTemplateRequest).build());
}
/**
*
* Describes existing Models defined for a RestApi resource.
*
*
* @param getModelsRequest
* Request to list existing Models defined for a RestApi resource.
* @return Result of the GetModels operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetModels
*/
default GetModelsResponse getModels(GetModelsRequest getModelsRequest) throws BadRequestException, UnauthorizedException,
NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Describes existing Models defined for a RestApi resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetModelsRequest.Builder} avoiding the need to
* create one manually via {@link GetModelsRequest#builder()}
*
*
* @param getModelsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetModelsRequest.Builder} to create a request.
* Request to list existing Models defined for a RestApi resource.
* @return Result of the GetModels operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetModels
*/
default GetModelsResponse getModels(Consumer getModelsRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getModels(GetModelsRequest.builder().applyMutation(getModelsRequest).build());
}
/**
*
* This is a variant of {@link #getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetModelsIterable responses = client.getModelsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetModelsIterable responses = client.getModelsPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetModelsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetModelsIterable responses = client.getModelsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest)} operation.
*
*
* @param getModelsRequest
* Request to list existing Models defined for a RestApi resource.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetModels
*/
default GetModelsIterable getModelsPaginator(GetModelsRequest getModelsRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return new GetModelsIterable(this, getModelsRequest);
}
/**
*
* This is a variant of {@link #getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetModelsIterable responses = client.getModelsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetModelsIterable responses = client.getModelsPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetModelsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetModelsIterable responses = client.getModelsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetModelsRequest.Builder} avoiding the need to
* create one manually via {@link GetModelsRequest#builder()}
*
*
* @param getModelsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetModelsRequest.Builder} to create a request.
* Request to list existing Models defined for a RestApi resource.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetModels
*/
default GetModelsIterable getModelsPaginator(Consumer getModelsRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getModelsPaginator(GetModelsRequest.builder().applyMutation(getModelsRequest).build());
}
/**
*
* Gets a RequestValidator of a given RestApi.
*
*
* @param getRequestValidatorRequest
* Gets a RequestValidator of a given RestApi.
* @return Result of the GetRequestValidator operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetRequestValidator
*/
default GetRequestValidatorResponse getRequestValidator(GetRequestValidatorRequest getRequestValidatorRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets a RequestValidator of a given RestApi.
*
*
*
* This is a convenience which creates an instance of the {@link GetRequestValidatorRequest.Builder} avoiding the
* need to create one manually via {@link GetRequestValidatorRequest#builder()}
*
*
* @param getRequestValidatorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetRequestValidatorRequest.Builder} to create a
* request. Gets a RequestValidator of a given RestApi.
* @return Result of the GetRequestValidator operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetRequestValidator
*/
default GetRequestValidatorResponse getRequestValidator(
Consumer getRequestValidatorRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getRequestValidator(GetRequestValidatorRequest.builder().applyMutation(getRequestValidatorRequest).build());
}
/**
*
* Gets the RequestValidators collection of a given RestApi.
*
*
* @param getRequestValidatorsRequest
* Gets the RequestValidators collection of a given RestApi.
* @return Result of the GetRequestValidators operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetRequestValidators
*/
default GetRequestValidatorsResponse getRequestValidators(GetRequestValidatorsRequest getRequestValidatorsRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets the RequestValidators collection of a given RestApi.
*
*
*
* This is a convenience which creates an instance of the {@link GetRequestValidatorsRequest.Builder} avoiding the
* need to create one manually via {@link GetRequestValidatorsRequest#builder()}
*
*
* @param getRequestValidatorsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetRequestValidatorsRequest.Builder} to create a
* request. Gets the RequestValidators collection of a given RestApi.
* @return Result of the GetRequestValidators operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetRequestValidators
*/
default GetRequestValidatorsResponse getRequestValidators(
Consumer getRequestValidatorsRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getRequestValidators(GetRequestValidatorsRequest.builder().applyMutation(getRequestValidatorsRequest).build());
}
/**
*
* Lists information about a resource.
*
*
* @param getResourceRequest
* Request to list information about a resource.
* @return Result of the GetResource operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetResource
*/
default GetResourceResponse getResource(GetResourceRequest getResourceRequest) throws UnauthorizedException,
NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Lists information about a resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetResourceRequest.Builder} avoiding the need to
* create one manually via {@link GetResourceRequest#builder()}
*
*
* @param getResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetResourceRequest.Builder} to create a request.
* Request to list information about a resource.
* @return Result of the GetResource operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetResource
*/
default GetResourceResponse getResource(Consumer getResourceRequest)
throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getResource(GetResourceRequest.builder().applyMutation(getResourceRequest).build());
}
/**
*
* Lists information about a collection of Resource resources.
*
*
* @param getResourcesRequest
* Request to list information about a collection of resources.
* @return Result of the GetResources operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetResources
*/
default GetResourcesResponse getResources(GetResourcesRequest getResourcesRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Lists information about a collection of Resource resources.
*
*
*
* This is a convenience which creates an instance of the {@link GetResourcesRequest.Builder} avoiding the need to
* create one manually via {@link GetResourcesRequest#builder()}
*
*
* @param getResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetResourcesRequest.Builder} to create a request.
* Request to list information about a collection of resources.
* @return Result of the GetResources operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetResources
*/
default GetResourcesResponse getResources(Consumer getResourcesRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getResources(GetResourcesRequest.builder().applyMutation(getResourcesRequest).build());
}
/**
*
* This is a variant of {@link #getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetResourcesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest)} operation.
*
*
* @param getResourcesRequest
* Request to list information about a collection of resources.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetResources
*/
default GetResourcesIterable getResourcesPaginator(GetResourcesRequest getResourcesRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return new GetResourcesIterable(this, getResourcesRequest);
}
/**
*
* This is a variant of {@link #getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetResourcesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetResourcesRequest.Builder} avoiding the need to
* create one manually via {@link GetResourcesRequest#builder()}
*
*
* @param getResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetResourcesRequest.Builder} to create a request.
* Request to list information about a collection of resources.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetResources
*/
default GetResourcesIterable getResourcesPaginator(Consumer getResourcesRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getResourcesPaginator(GetResourcesRequest.builder().applyMutation(getResourcesRequest).build());
}
/**
*
* Lists the RestApi resource in the collection.
*
*
* @param getRestApiRequest
* The GET request to list an existing RestApi defined for your collection.
* @return Result of the GetRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetRestApi
*/
default GetRestApiResponse getRestApi(GetRestApiRequest getRestApiRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the RestApi resource in the collection.
*
*
*
* This is a convenience which creates an instance of the {@link GetRestApiRequest.Builder} avoiding the need to
* create one manually via {@link GetRestApiRequest#builder()}
*
*
* @param getRestApiRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetRestApiRequest.Builder} to create a request.
* The GET request to list an existing RestApi defined for your collection.
* @return Result of the GetRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetRestApi
*/
default GetRestApiResponse getRestApi(Consumer getRestApiRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getRestApi(GetRestApiRequest.builder().applyMutation(getRestApiRequest).build());
}
/**
*
* Lists the RestApis resources for your collection.
*
*
* @param getRestApisRequest
* The GET request to list existing RestApis defined for your collection.
* @return Result of the GetRestApis operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetRestApis
*/
default GetRestApisResponse getRestApis(GetRestApisRequest getRestApisRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the RestApis resources for your collection.
*
*
*
* This is a convenience which creates an instance of the {@link GetRestApisRequest.Builder} avoiding the need to
* create one manually via {@link GetRestApisRequest#builder()}
*
*
* @param getRestApisRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetRestApisRequest.Builder} to create a request.
* The GET request to list existing RestApis defined for your collection.
* @return Result of the GetRestApis operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetRestApis
*/
default GetRestApisResponse getRestApis(Consumer getRestApisRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getRestApis(GetRestApisRequest.builder().applyMutation(getRestApisRequest).build());
}
/**
*
* Lists the RestApis resources for your collection.
*
*
* @return Result of the GetRestApis operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetRestApis
* @see #getRestApis(GetRestApisRequest)
*/
default GetRestApisResponse getRestApis() throws BadRequestException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getRestApis(GetRestApisRequest.builder().build());
}
/**
*
* This is a variant of {@link #getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetRestApisResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetRestApis
* @see #getRestApisPaginator(GetRestApisRequest)
*/
default GetRestApisIterable getRestApisPaginator() throws BadRequestException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getRestApisPaginator(GetRestApisRequest.builder().build());
}
/**
*
* This is a variant of {@link #getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetRestApisResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)} operation.
*
*
* @param getRestApisRequest
* The GET request to list existing RestApis defined for your collection.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetRestApis
*/
default GetRestApisIterable getRestApisPaginator(GetRestApisRequest getRestApisRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return new GetRestApisIterable(this, getRestApisRequest);
}
/**
*
* This is a variant of {@link #getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetRestApisResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetRestApisRequest.Builder} avoiding the need to
* create one manually via {@link GetRestApisRequest#builder()}
*
*
* @param getRestApisRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetRestApisRequest.Builder} to create a request.
* The GET request to list existing RestApis defined for your collection.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetRestApis
*/
default GetRestApisIterable getRestApisPaginator(Consumer getRestApisRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getRestApisPaginator(GetRestApisRequest.builder().applyMutation(getRestApisRequest).build());
}
/**
*
* Generates a client SDK for a RestApi and Stage.
*
*
* @param getSdkRequest
* Request a new generated client SDK for a RestApi and Stage.
* @return Result of the GetSdk operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetSdk
*/
default GetSdkResponse getSdk(GetSdkRequest getSdkRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Generates a client SDK for a RestApi and Stage.
*
*
*
* This is a convenience which creates an instance of the {@link GetSdkRequest.Builder} avoiding the need to create
* one manually via {@link GetSdkRequest#builder()}
*
*
* @param getSdkRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetSdkRequest.Builder} to create a request.
* Request a new generated client SDK for a RestApi and Stage.
* @return Result of the GetSdk operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetSdk
*/
default GetSdkResponse getSdk(Consumer getSdkRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getSdk(GetSdkRequest.builder().applyMutation(getSdkRequest).build());
}
/**
*
* Gets an SDK type.
*
*
* @param getSdkTypeRequest
* Get an SdkType instance.
* @return Result of the GetSdkType operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetSdkType
*/
default GetSdkTypeResponse getSdkType(GetSdkTypeRequest getSdkTypeRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets an SDK type.
*
*
*
* This is a convenience which creates an instance of the {@link GetSdkTypeRequest.Builder} avoiding the need to
* create one manually via {@link GetSdkTypeRequest#builder()}
*
*
* @param getSdkTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetSdkTypeRequest.Builder} to create a request.
* Get an SdkType instance.
* @return Result of the GetSdkType operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetSdkType
*/
default GetSdkTypeResponse getSdkType(Consumer getSdkTypeRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getSdkType(GetSdkTypeRequest.builder().applyMutation(getSdkTypeRequest).build());
}
/**
*
* Gets SDK types
*
*
* @param getSdkTypesRequest
* Get the SdkTypes collection.
* @return Result of the GetSdkTypes operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetSdkTypes
*/
default GetSdkTypesResponse getSdkTypes(GetSdkTypesRequest getSdkTypesRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets SDK types
*
*
*
* This is a convenience which creates an instance of the {@link GetSdkTypesRequest.Builder} avoiding the need to
* create one manually via {@link GetSdkTypesRequest#builder()}
*
*
* @param getSdkTypesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetSdkTypesRequest.Builder} to create a request.
* Get the SdkTypes collection.
* @return Result of the GetSdkTypes operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetSdkTypes
*/
default GetSdkTypesResponse getSdkTypes(Consumer getSdkTypesRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getSdkTypes(GetSdkTypesRequest.builder().applyMutation(getSdkTypesRequest).build());
}
/**
*
* Gets SDK types
*
*
* @return Result of the GetSdkTypes operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetSdkTypes
* @see #getSdkTypes(GetSdkTypesRequest)
*/
default GetSdkTypesResponse getSdkTypes() throws BadRequestException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getSdkTypes(GetSdkTypesRequest.builder().build());
}
/**
*
* Gets information about a Stage resource.
*
*
* @param getStageRequest
* Requests API Gateway to get information about a Stage resource.
* @return Result of the GetStage operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetStage
*/
default GetStageResponse getStage(GetStageRequest getStageRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about a Stage resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetStageRequest.Builder} avoiding the need to
* create one manually via {@link GetStageRequest#builder()}
*
*
* @param getStageRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetStageRequest.Builder} to create a request.
* Requests API Gateway to get information about a Stage resource.
* @return Result of the GetStage operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetStage
*/
default GetStageResponse getStage(Consumer getStageRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return getStage(GetStageRequest.builder().applyMutation(getStageRequest).build());
}
/**
*
* Gets information about one or more Stage resources.
*
*
* @param getStagesRequest
* Requests API Gateway to get information about one or more Stage resources.
* @return Result of the GetStages operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetStages
*/
default GetStagesResponse getStages(GetStagesRequest getStagesRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about one or more Stage resources.
*
*
*
* This is a convenience which creates an instance of the {@link GetStagesRequest.Builder} avoiding the need to
* create one manually via {@link GetStagesRequest#builder()}
*
*
* @param getStagesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetStagesRequest.Builder} to create a request.
* Requests API Gateway to get information about one or more Stage resources.
* @return Result of the GetStages operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetStages
*/
default GetStagesResponse getStages(Consumer getStagesRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return getStages(GetStagesRequest.builder().applyMutation(getStagesRequest).build());
}
/**
*
* Gets the Tags collection for a given resource.
*
*
* @param getTagsRequest
* Gets the Tags collection for a given resource.
* @return Result of the GetTags operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetTags
*/
default GetTagsResponse getTags(GetTagsRequest getTagsRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets the Tags collection for a given resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetTagsRequest.Builder} avoiding the need to create
* one manually via {@link GetTagsRequest#builder()}
*
*
* @param getTagsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetTagsRequest.Builder} to create a request. Gets
* the Tags collection for a given resource.
* @return Result of the GetTags operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetTags
*/
default GetTagsResponse getTags(Consumer getTagsRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getTags(GetTagsRequest.builder().applyMutation(getTagsRequest).build());
}
/**
*
* Gets the usage data of a usage plan in a specified time interval.
*
*
* @param getUsageRequest
* The GET request to get the usage data of a usage plan in a specified time interval.
* @return Result of the GetUsage operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsage
*/
default GetUsageResponse getUsage(GetUsageRequest getUsageRequest) throws BadRequestException, UnauthorizedException,
NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets the usage data of a usage plan in a specified time interval.
*
*
*
* This is a convenience which creates an instance of the {@link GetUsageRequest.Builder} avoiding the need to
* create one manually via {@link GetUsageRequest#builder()}
*
*
* @param getUsageRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetUsageRequest.Builder} to create a request. The
* GET request to get the usage data of a usage plan in a specified time interval.
* @return Result of the GetUsage operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsage
*/
default GetUsageResponse getUsage(Consumer getUsageRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getUsage(GetUsageRequest.builder().applyMutation(getUsageRequest).build());
}
/**
*
* This is a variant of {@link #getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsageIterable responses = client.getUsagePaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetUsageIterable responses = client.getUsagePaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetUsageResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsageIterable responses = client.getUsagePaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest)} operation.
*
*
* @param getUsageRequest
* The GET request to get the usage data of a usage plan in a specified time interval.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsage
*/
default GetUsageIterable getUsagePaginator(GetUsageRequest getUsageRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return new GetUsageIterable(this, getUsageRequest);
}
/**
*
* This is a variant of {@link #getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsageIterable responses = client.getUsagePaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetUsageIterable responses = client.getUsagePaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetUsageResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsageIterable responses = client.getUsagePaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetUsageRequest.Builder} avoiding the need to
* create one manually via {@link GetUsageRequest#builder()}
*
*
* @param getUsageRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetUsageRequest.Builder} to create a request. The
* GET request to get the usage data of a usage plan in a specified time interval.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsage
*/
default GetUsageIterable getUsagePaginator(Consumer getUsageRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getUsagePaginator(GetUsageRequest.builder().applyMutation(getUsageRequest).build());
}
/**
*
* Gets a usage plan of a given plan identifier.
*
*
* @param getUsagePlanRequest
* The GET request to get a usage plan of a given plan identifier.
* @return Result of the GetUsagePlan operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlan
*/
default GetUsagePlanResponse getUsagePlan(GetUsagePlanRequest getUsagePlanRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets a usage plan of a given plan identifier.
*
*
*
* This is a convenience which creates an instance of the {@link GetUsagePlanRequest.Builder} avoiding the need to
* create one manually via {@link GetUsagePlanRequest#builder()}
*
*
* @param getUsagePlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetUsagePlanRequest.Builder} to create a request.
* The GET request to get a usage plan of a given plan identifier.
* @return Result of the GetUsagePlan operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlan
*/
default GetUsagePlanResponse getUsagePlan(Consumer getUsagePlanRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getUsagePlan(GetUsagePlanRequest.builder().applyMutation(getUsagePlanRequest).build());
}
/**
*
* Gets a usage plan key of a given key identifier.
*
*
* @param getUsagePlanKeyRequest
* The GET request to get a usage plan key of a given key identifier.
* @return Result of the GetUsagePlanKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlanKey
*/
default GetUsagePlanKeyResponse getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets a usage plan key of a given key identifier.
*
*
*
* This is a convenience which creates an instance of the {@link GetUsagePlanKeyRequest.Builder} avoiding the need
* to create one manually via {@link GetUsagePlanKeyRequest#builder()}
*
*
* @param getUsagePlanKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeyRequest.Builder} to create a
* request. The GET request to get a usage plan key of a given key identifier.
* @return Result of the GetUsagePlanKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlanKey
*/
default GetUsagePlanKeyResponse getUsagePlanKey(Consumer getUsagePlanKeyRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getUsagePlanKey(GetUsagePlanKeyRequest.builder().applyMutation(getUsagePlanKeyRequest).build());
}
/**
*
* Gets all the usage plan keys representing the API keys added to a specified usage plan.
*
*
* @param getUsagePlanKeysRequest
* The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
* @return Result of the GetUsagePlanKeys operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlanKeys
*/
default GetUsagePlanKeysResponse getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets all the usage plan keys representing the API keys added to a specified usage plan.
*
*
*
* This is a convenience which creates an instance of the {@link GetUsagePlanKeysRequest.Builder} avoiding the need
* to create one manually via {@link GetUsagePlanKeysRequest#builder()}
*
*
* @param getUsagePlanKeysRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest.Builder} to create a
* request. The GET request to get all the usage plan keys representing the API keys added to a specified
* usage plan.
* @return Result of the GetUsagePlanKeys operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlanKeys
*/
default GetUsagePlanKeysResponse getUsagePlanKeys(Consumer getUsagePlanKeysRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getUsagePlanKeys(GetUsagePlanKeysRequest.builder().applyMutation(getUsagePlanKeysRequest).build());
}
/**
*
* This is a variant of
* {@link #getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest)} operation.
* The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysIterable responses = client.getUsagePlanKeysPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysIterable responses = client
* .getUsagePlanKeysPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysIterable responses = client.getUsagePlanKeysPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest)}
* operation.
*
*
* @param getUsagePlanKeysRequest
* The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlanKeys
*/
default GetUsagePlanKeysIterable getUsagePlanKeysPaginator(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return new GetUsagePlanKeysIterable(this, getUsagePlanKeysRequest);
}
/**
*
* This is a variant of
* {@link #getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest)} operation.
* The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysIterable responses = client.getUsagePlanKeysPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysIterable responses = client
* .getUsagePlanKeysPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysIterable responses = client.getUsagePlanKeysPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetUsagePlanKeysRequest.Builder} avoiding the need
* to create one manually via {@link GetUsagePlanKeysRequest#builder()}
*
*
* @param getUsagePlanKeysRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest.Builder} to create a
* request. The GET request to get all the usage plan keys representing the API keys added to a specified
* usage plan.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlanKeys
*/
default GetUsagePlanKeysIterable getUsagePlanKeysPaginator(Consumer getUsagePlanKeysRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getUsagePlanKeysPaginator(GetUsagePlanKeysRequest.builder().applyMutation(getUsagePlanKeysRequest).build());
}
/**
*
* Gets all the usage plans of the caller's account.
*
*
* @param getUsagePlansRequest
* The GET request to get all the usage plans of the caller's account.
* @return Result of the GetUsagePlans operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlans
*/
default GetUsagePlansResponse getUsagePlans(GetUsagePlansRequest getUsagePlansRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets all the usage plans of the caller's account.
*
*
*
* This is a convenience which creates an instance of the {@link GetUsagePlansRequest.Builder} avoiding the need to
* create one manually via {@link GetUsagePlansRequest#builder()}
*
*
* @param getUsagePlansRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest.Builder} to create a request.
* The GET request to get all the usage plans of the caller's account.
* @return Result of the GetUsagePlans operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlans
*/
default GetUsagePlansResponse getUsagePlans(Consumer getUsagePlansRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getUsagePlans(GetUsagePlansRequest.builder().applyMutation(getUsagePlansRequest).build());
}
/**
*
* Gets all the usage plans of the caller's account.
*
*
* @return Result of the GetUsagePlans operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlans
* @see #getUsagePlans(GetUsagePlansRequest)
*/
default GetUsagePlansResponse getUsagePlans() throws BadRequestException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getUsagePlans(GetUsagePlansRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client.getUsagePlansPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client
* .getUsagePlansPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client.getUsagePlansPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlans
* @see #getUsagePlansPaginator(GetUsagePlansRequest)
*/
default GetUsagePlansIterable getUsagePlansPaginator() throws BadRequestException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getUsagePlansPaginator(GetUsagePlansRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client.getUsagePlansPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client
* .getUsagePlansPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client.getUsagePlansPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest)} operation.
*
*
* @param getUsagePlansRequest
* The GET request to get all the usage plans of the caller's account.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlans
*/
default GetUsagePlansIterable getUsagePlansPaginator(GetUsagePlansRequest getUsagePlansRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return new GetUsagePlansIterable(this, getUsagePlansRequest);
}
/**
*
* This is a variant of
* {@link #getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client.getUsagePlansPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client
* .getUsagePlansPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client.getUsagePlansPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetUsagePlansRequest.Builder} avoiding the need to
* create one manually via {@link GetUsagePlansRequest#builder()}
*
*
* @param getUsagePlansRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest.Builder} to create a request.
* The GET request to get all the usage plans of the caller's account.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetUsagePlans
*/
default GetUsagePlansIterable getUsagePlansPaginator(Consumer getUsagePlansRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getUsagePlansPaginator(GetUsagePlansRequest.builder().applyMutation(getUsagePlansRequest).build());
}
/**
*
* Gets a specified VPC link under the caller's account in a region.
*
*
* @param getVpcLinkRequest
* Gets a specified VPC link under the caller's account in a region.
* @return Result of the GetVpcLink operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetVpcLink
*/
default GetVpcLinkResponse getVpcLink(GetVpcLinkRequest getVpcLinkRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets a specified VPC link under the caller's account in a region.
*
*
*
* This is a convenience which creates an instance of the {@link GetVpcLinkRequest.Builder} avoiding the need to
* create one manually via {@link GetVpcLinkRequest#builder()}
*
*
* @param getVpcLinkRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetVpcLinkRequest.Builder} to create a request.
* Gets a specified VPC link under the caller's account in a region.
* @return Result of the GetVpcLink operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetVpcLink
*/
default GetVpcLinkResponse getVpcLink(Consumer getVpcLinkRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getVpcLink(GetVpcLinkRequest.builder().applyMutation(getVpcLinkRequest).build());
}
/**
*
* Gets the VpcLinks collection under the caller's account in a selected region.
*
*
* @param getVpcLinksRequest
* Gets the VpcLinks collection under the caller's account in a selected region.
* @return Result of the GetVpcLinks operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetVpcLinks
*/
default GetVpcLinksResponse getVpcLinks(GetVpcLinksRequest getVpcLinksRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Gets the VpcLinks collection under the caller's account in a selected region.
*
*
*
* This is a convenience which creates an instance of the {@link GetVpcLinksRequest.Builder} avoiding the need to
* create one manually via {@link GetVpcLinksRequest#builder()}
*
*
* @param getVpcLinksRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest.Builder} to create a request.
* Gets the VpcLinks collection under the caller's account in a selected region.
* @return Result of the GetVpcLinks operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetVpcLinks
*/
default GetVpcLinksResponse getVpcLinks(Consumer getVpcLinksRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return getVpcLinks(GetVpcLinksRequest.builder().applyMutation(getVpcLinksRequest).build());
}
/**
*
* Gets the VpcLinks collection under the caller's account in a selected region.
*
*
* @return Result of the GetVpcLinks operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetVpcLinks
* @see #getVpcLinks(GetVpcLinksRequest)
*/
default GetVpcLinksResponse getVpcLinks() throws BadRequestException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getVpcLinks(GetVpcLinksRequest.builder().build());
}
/**
*
* This is a variant of {@link #getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetVpcLinks
* @see #getVpcLinksPaginator(GetVpcLinksRequest)
*/
default GetVpcLinksIterable getVpcLinksPaginator() throws BadRequestException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return getVpcLinksPaginator(GetVpcLinksRequest.builder().build());
}
/**
*
* This is a variant of {@link #getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest)} operation.
*
*
* @param getVpcLinksRequest
* Gets the VpcLinks collection under the caller's account in a selected region.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetVpcLinks
*/
default GetVpcLinksIterable getVpcLinksPaginator(GetVpcLinksRequest getVpcLinksRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return new GetVpcLinksIterable(this, getVpcLinksRequest);
}
/**
*
* This is a variant of {@link #getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
* for (software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetVpcLinksRequest.Builder} avoiding the need to
* create one manually via {@link GetVpcLinksRequest#builder()}
*
*
* @param getVpcLinksRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest.Builder} to create a request.
* Gets the VpcLinks collection under the caller's account in a selected region.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.GetVpcLinks
*/
default GetVpcLinksIterable getVpcLinksPaginator(Consumer getVpcLinksRequest)
throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return getVpcLinksPaginator(GetVpcLinksRequest.builder().applyMutation(getVpcLinksRequest).build());
}
/**
*
* Import API keys from an external source, such as a CSV-formatted file.
*
*
* @param importApiKeysRequest
* The POST request to import API keys from an external source, such as a CSV-formatted file.
* @return Result of the ImportApiKeys operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.ImportApiKeys
*/
default ImportApiKeysResponse importApiKeys(ImportApiKeysRequest importApiKeysRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Import API keys from an external source, such as a CSV-formatted file.
*
*
*
* This is a convenience which creates an instance of the {@link ImportApiKeysRequest.Builder} avoiding the need to
* create one manually via {@link ImportApiKeysRequest#builder()}
*
*
* @param importApiKeysRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.ImportApiKeysRequest.Builder} to create a request.
* The POST request to import API keys from an external source, such as a CSV-formatted file.
* @return Result of the ImportApiKeys operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.ImportApiKeys
*/
default ImportApiKeysResponse importApiKeys(Consumer importApiKeysRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return importApiKeys(ImportApiKeysRequest.builder().applyMutation(importApiKeysRequest).build());
}
/**
*
* Imports documentation parts
*
*
* @param importDocumentationPartsRequest
* Import documentation parts from an external (e.g., OpenAPI) definition file.
* @return Result of the ImportDocumentationParts operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.ImportDocumentationParts
*/
default ImportDocumentationPartsResponse importDocumentationParts(
ImportDocumentationPartsRequest importDocumentationPartsRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Imports documentation parts
*
*
*
* This is a convenience which creates an instance of the {@link ImportDocumentationPartsRequest.Builder} avoiding
* the need to create one manually via {@link ImportDocumentationPartsRequest#builder()}
*
*
* @param importDocumentationPartsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.ImportDocumentationPartsRequest.Builder} to create
* a request. Import documentation parts from an external (e.g., OpenAPI) definition file.
* @return Result of the ImportDocumentationParts operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.ImportDocumentationParts
*/
default ImportDocumentationPartsResponse importDocumentationParts(
Consumer importDocumentationPartsRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return importDocumentationParts(ImportDocumentationPartsRequest.builder().applyMutation(importDocumentationPartsRequest)
.build());
}
/**
*
* A feature of the API Gateway control service for creating a new API from an external API definition file.
*
*
* @param importRestApiRequest
* A POST request to import an API to API Gateway using an input of an API definition file.
* @return Result of the ImportRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.ImportRestApi
*/
default ImportRestApiResponse importRestApi(ImportRestApiRequest importRestApiRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* A feature of the API Gateway control service for creating a new API from an external API definition file.
*
*
*
* This is a convenience which creates an instance of the {@link ImportRestApiRequest.Builder} avoiding the need to
* create one manually via {@link ImportRestApiRequest#builder()}
*
*
* @param importRestApiRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.ImportRestApiRequest.Builder} to create a request.
* A POST request to import an API to API Gateway using an input of an API definition file.
* @return Result of the ImportRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.ImportRestApi
*/
default ImportRestApiResponse importRestApi(Consumer importRestApiRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return importRestApi(ImportRestApiRequest.builder().applyMutation(importRestApiRequest).build());
}
/**
*
* Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
*
*
* @param putGatewayResponseRequest
* Creates a customization of a GatewayResponse of a specified response type and status code on the given
* RestApi.
* @return Result of the PutGatewayResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.PutGatewayResponse
*/
default PutGatewayResponseResponse putGatewayResponse(PutGatewayResponseRequest putGatewayResponseRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
*
*
*
* This is a convenience which creates an instance of the {@link PutGatewayResponseRequest.Builder} avoiding the
* need to create one manually via {@link PutGatewayResponseRequest#builder()}
*
*
* @param putGatewayResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.PutGatewayResponseRequest.Builder} to create a
* request. Creates a customization of a GatewayResponse of a specified response type and status code on the
* given RestApi.
* @return Result of the PutGatewayResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.PutGatewayResponse
*/
default PutGatewayResponseResponse putGatewayResponse(Consumer putGatewayResponseRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return putGatewayResponse(PutGatewayResponseRequest.builder().applyMutation(putGatewayResponseRequest).build());
}
/**
*
* Sets up a method's integration.
*
*
* @param putIntegrationRequest
* Sets up a method's integration.
* @return Result of the PutIntegration operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.PutIntegration
*/
default PutIntegrationResponse putIntegration(PutIntegrationRequest putIntegrationRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Sets up a method's integration.
*
*
*
* This is a convenience which creates an instance of the {@link PutIntegrationRequest.Builder} avoiding the need to
* create one manually via {@link PutIntegrationRequest#builder()}
*
*
* @param putIntegrationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.PutIntegrationRequest.Builder} to create a
* request. Sets up a method's integration.
* @return Result of the PutIntegration operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.PutIntegration
*/
default PutIntegrationResponse putIntegration(Consumer putIntegrationRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return putIntegration(PutIntegrationRequest.builder().applyMutation(putIntegrationRequest).build());
}
/**
*
* Represents a put integration.
*
*
* @param putIntegrationResponseRequest
* Represents a put integration response request.
* @return Result of the PutIntegrationResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.PutIntegrationResponse
*/
default PutIntegrationResponseResponse putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Represents a put integration.
*
*
*
* This is a convenience which creates an instance of the {@link PutIntegrationResponseRequest.Builder} avoiding the
* need to create one manually via {@link PutIntegrationResponseRequest#builder()}
*
*
* @param putIntegrationResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.PutIntegrationResponseRequest.Builder} to create a
* request. Represents a put integration response request.
* @return Result of the PutIntegrationResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.PutIntegrationResponse
*/
default PutIntegrationResponseResponse putIntegrationResponse(
Consumer putIntegrationResponseRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return putIntegrationResponse(PutIntegrationResponseRequest.builder().applyMutation(putIntegrationResponseRequest)
.build());
}
/**
*
* Add a method to an existing Resource resource.
*
*
* @param putMethodRequest
* Request to add a method to an existing Resource resource.
* @return Result of the PutMethod operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.PutMethod
*/
default PutMethodResponse putMethod(PutMethodRequest putMethodRequest) throws BadRequestException, UnauthorizedException,
NotFoundException, ConflictException, LimitExceededException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Add a method to an existing Resource resource.
*
*
*
* This is a convenience which creates an instance of the {@link PutMethodRequest.Builder} avoiding the need to
* create one manually via {@link PutMethodRequest#builder()}
*
*
* @param putMethodRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.PutMethodRequest.Builder} to create a request.
* Request to add a method to an existing Resource resource.
* @return Result of the PutMethod operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.PutMethod
*/
default PutMethodResponse putMethod(Consumer putMethodRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return putMethod(PutMethodRequest.builder().applyMutation(putMethodRequest).build());
}
/**
*
* Adds a MethodResponse to an existing Method resource.
*
*
* @param putMethodResponseRequest
* Request to add a MethodResponse to an existing Method resource.
* @return Result of the PutMethodResponse operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.PutMethodResponse
*/
default PutMethodResponseResponse putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)
throws UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, BadRequestException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Adds a MethodResponse to an existing Method resource.
*
*
*
* This is a convenience which creates an instance of the {@link PutMethodResponseRequest.Builder} avoiding the need
* to create one manually via {@link PutMethodResponseRequest#builder()}
*
*
* @param putMethodResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.PutMethodResponseRequest.Builder} to create a
* request. Request to add a MethodResponse to an existing Method resource.
* @return Result of the PutMethodResponse operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.PutMethodResponse
*/
default PutMethodResponseResponse putMethodResponse(Consumer putMethodResponseRequest)
throws UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, BadRequestException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return putMethodResponse(PutMethodResponseRequest.builder().applyMutation(putMethodResponseRequest).build());
}
/**
*
* A feature of the API Gateway control service for updating an existing API with an input of external API
* definitions. The update can take the form of merging the supplied definition into the existing API or overwriting
* the existing API.
*
*
* @param putRestApiRequest
* A PUT request to update an existing API, with external API definitions specified as the request body.
* @return Result of the PutRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.PutRestApi
*/
default PutRestApiResponse putRestApi(PutRestApiRequest putRestApiRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* A feature of the API Gateway control service for updating an existing API with an input of external API
* definitions. The update can take the form of merging the supplied definition into the existing API or overwriting
* the existing API.
*
*
*
* This is a convenience which creates an instance of the {@link PutRestApiRequest.Builder} avoiding the need to
* create one manually via {@link PutRestApiRequest#builder()}
*
*
* @param putRestApiRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.PutRestApiRequest.Builder} to create a request. A
* PUT request to update an existing API, with external API definitions specified as the request body.
* @return Result of the PutRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.PutRestApi
*/
default PutRestApiResponse putRestApi(Consumer putRestApiRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return putRestApi(PutRestApiRequest.builder().applyMutation(putRestApiRequest).build());
}
/**
*
* Adds or updates a tag on a given resource.
*
*
* @param tagResourceRequest
* Adds or updates a tag on a given resource.
* @return Result of the TagResource operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.TagResource
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Adds or updates a tag on a given resource.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.TagResourceRequest.Builder} to create a request.
* Adds or updates a tag on a given resource.
* @return Result of the TagResource operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.TagResource
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
*
*
* @param testInvokeAuthorizerRequest
* Make a request to simulate the invocation of an Authorizer.
* @return Result of the TestInvokeAuthorizer operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.TestInvokeAuthorizer
*/
default TestInvokeAuthorizerResponse testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
*
*
*
* This is a convenience which creates an instance of the {@link TestInvokeAuthorizerRequest.Builder} avoiding the
* need to create one manually via {@link TestInvokeAuthorizerRequest#builder()}
*
*
* @param testInvokeAuthorizerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.TestInvokeAuthorizerRequest.Builder} to create a
* request. Make a request to simulate the invocation of an Authorizer.
* @return Result of the TestInvokeAuthorizer operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.TestInvokeAuthorizer
*/
default TestInvokeAuthorizerResponse testInvokeAuthorizer(
Consumer testInvokeAuthorizerRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
ApiGatewayException {
return testInvokeAuthorizer(TestInvokeAuthorizerRequest.builder().applyMutation(testInvokeAuthorizerRequest).build());
}
/**
*
* Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
*
*
* @param testInvokeMethodRequest
* Make a request to simulate the invocation of a Method.
* @return Result of the TestInvokeMethod operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.TestInvokeMethod
*/
default TestInvokeMethodResponse testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
*
*
*
* This is a convenience which creates an instance of the {@link TestInvokeMethodRequest.Builder} avoiding the need
* to create one manually via {@link TestInvokeMethodRequest#builder()}
*
*
* @param testInvokeMethodRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.TestInvokeMethodRequest.Builder} to create a
* request. Make a request to simulate the invocation of a Method.
* @return Result of the TestInvokeMethod operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.TestInvokeMethod
*/
default TestInvokeMethodResponse testInvokeMethod(Consumer testInvokeMethodRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
return testInvokeMethod(TestInvokeMethodRequest.builder().applyMutation(testInvokeMethodRequest).build());
}
/**
*
* Removes a tag from a given resource.
*
*
* @param untagResourceRequest
* Removes a tag from a given resource.
* @return Result of the UntagResource operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UntagResource
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Removes a tag from a given resource.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UntagResourceRequest.Builder} to create a request.
* Removes a tag from a given resource.
* @return Result of the UntagResource operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UntagResource
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Changes information about the current Account resource.
*
*
* @param updateAccountRequest
* Requests API Gateway to change information about the current Account resource.
* @return Result of the UpdateAccount operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateAccount
*/
default UpdateAccountResponse updateAccount(UpdateAccountRequest updateAccountRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Changes information about the current Account resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateAccountRequest.Builder} avoiding the need to
* create one manually via {@link UpdateAccountRequest#builder()}
*
*
* @param updateAccountRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateAccountRequest.Builder} to create a request.
* Requests API Gateway to change information about the current Account resource.
* @return Result of the UpdateAccount operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateAccount
*/
default UpdateAccountResponse updateAccount(Consumer updateAccountRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return updateAccount(UpdateAccountRequest.builder().applyMutation(updateAccountRequest).build());
}
/**
*
* Changes information about an ApiKey resource.
*
*
* @param updateApiKeyRequest
* A request to change information about an ApiKey resource.
* @return Result of the UpdateApiKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateApiKey
*/
default UpdateApiKeyResponse updateApiKey(UpdateApiKeyRequest updateApiKeyRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Changes information about an ApiKey resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateApiKeyRequest.Builder} avoiding the need to
* create one manually via {@link UpdateApiKeyRequest#builder()}
*
*
* @param updateApiKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateApiKeyRequest.Builder} to create a request.
* A request to change information about an ApiKey resource.
* @return Result of the UpdateApiKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateApiKey
*/
default UpdateApiKeyResponse updateApiKey(Consumer updateApiKeyRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return updateApiKey(UpdateApiKeyRequest.builder().applyMutation(updateApiKeyRequest).build());
}
/**
*
* Updates an existing Authorizer resource.
*
*
* @param updateAuthorizerRequest
* Request to update an existing Authorizer resource.
* @return Result of the UpdateAuthorizer operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateAuthorizer
*/
default UpdateAuthorizerResponse updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an existing Authorizer resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateAuthorizerRequest.Builder} avoiding the need
* to create one manually via {@link UpdateAuthorizerRequest#builder()}
*
*
* @param updateAuthorizerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateAuthorizerRequest.Builder} to create a
* request. Request to update an existing Authorizer resource.
* @return Result of the UpdateAuthorizer operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateAuthorizer
*/
default UpdateAuthorizerResponse updateAuthorizer(Consumer updateAuthorizerRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return updateAuthorizer(UpdateAuthorizerRequest.builder().applyMutation(updateAuthorizerRequest).build());
}
/**
*
* Changes information about the BasePathMapping resource.
*
*
* @param updateBasePathMappingRequest
* A request to change information about the BasePathMapping resource.
* @return Result of the UpdateBasePathMapping operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateBasePathMapping
*/
default UpdateBasePathMappingResponse updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Changes information about the BasePathMapping resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateBasePathMappingRequest.Builder} avoiding the
* need to create one manually via {@link UpdateBasePathMappingRequest#builder()}
*
*
* @param updateBasePathMappingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateBasePathMappingRequest.Builder} to create a
* request. A request to change information about the BasePathMapping resource.
* @return Result of the UpdateBasePathMapping operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateBasePathMapping
*/
default UpdateBasePathMappingResponse updateBasePathMapping(
Consumer updateBasePathMappingRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return updateBasePathMapping(UpdateBasePathMappingRequest.builder().applyMutation(updateBasePathMappingRequest).build());
}
/**
*
* Changes information about an ClientCertificate resource.
*
*
* @param updateClientCertificateRequest
* A request to change information about an ClientCertificate resource.
* @return Result of the UpdateClientCertificate operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateClientCertificate
*/
default UpdateClientCertificateResponse updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Changes information about an ClientCertificate resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateClientCertificateRequest.Builder} avoiding
* the need to create one manually via {@link UpdateClientCertificateRequest#builder()}
*
*
* @param updateClientCertificateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateClientCertificateRequest.Builder} to create
* a request. A request to change information about an ClientCertificate resource.
* @return Result of the UpdateClientCertificate operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateClientCertificate
*/
default UpdateClientCertificateResponse updateClientCertificate(
Consumer updateClientCertificateRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return updateClientCertificate(UpdateClientCertificateRequest.builder().applyMutation(updateClientCertificateRequest)
.build());
}
/**
*
* Changes information about a Deployment resource.
*
*
* @param updateDeploymentRequest
* Requests API Gateway to change information about a Deployment resource.
* @return Result of the UpdateDeployment operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ServiceUnavailableException
* The requested service is not available. For details see the accompanying error message. Retry after the
* specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateDeployment
*/
default UpdateDeploymentResponse updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Changes information about a Deployment resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateDeploymentRequest.Builder} avoiding the need
* to create one manually via {@link UpdateDeploymentRequest#builder()}
*
*
* @param updateDeploymentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateDeploymentRequest.Builder} to create a
* request. Requests API Gateway to change information about a Deployment resource.
* @return Result of the UpdateDeployment operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ServiceUnavailableException
* The requested service is not available. For details see the accompanying error message. Retry after the
* specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateDeployment
*/
default UpdateDeploymentResponse updateDeployment(Consumer updateDeploymentRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, ApiGatewayException {
return updateDeployment(UpdateDeploymentRequest.builder().applyMutation(updateDeploymentRequest).build());
}
/**
*
* Updates a documentation part.
*
*
* @param updateDocumentationPartRequest
* Updates an existing documentation part of a given API.
* @return Result of the UpdateDocumentationPart operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateDocumentationPart
*/
default UpdateDocumentationPartResponse updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a documentation part.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateDocumentationPartRequest.Builder} avoiding
* the need to create one manually via {@link UpdateDocumentationPartRequest#builder()}
*
*
* @param updateDocumentationPartRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateDocumentationPartRequest.Builder} to create
* a request. Updates an existing documentation part of a given API.
* @return Result of the UpdateDocumentationPart operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateDocumentationPart
*/
default UpdateDocumentationPartResponse updateDocumentationPart(
Consumer updateDocumentationPartRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return updateDocumentationPart(UpdateDocumentationPartRequest.builder().applyMutation(updateDocumentationPartRequest)
.build());
}
/**
*
* Updates a documentation version.
*
*
* @param updateDocumentationVersionRequest
* Updates an existing documentation version of an API.
* @return Result of the UpdateDocumentationVersion operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateDocumentationVersion
*/
default UpdateDocumentationVersionResponse updateDocumentationVersion(
UpdateDocumentationVersionRequest updateDocumentationVersionRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a documentation version.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateDocumentationVersionRequest.Builder} avoiding
* the need to create one manually via {@link UpdateDocumentationVersionRequest#builder()}
*
*
* @param updateDocumentationVersionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateDocumentationVersionRequest.Builder} to
* create a request. Updates an existing documentation version of an API.
* @return Result of the UpdateDocumentationVersion operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateDocumentationVersion
*/
default UpdateDocumentationVersionResponse updateDocumentationVersion(
Consumer updateDocumentationVersionRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return updateDocumentationVersion(UpdateDocumentationVersionRequest.builder()
.applyMutation(updateDocumentationVersionRequest).build());
}
/**
*
* Changes information about the DomainName resource.
*
*
* @param updateDomainNameRequest
* A request to change information about the DomainName resource.
* @return Result of the UpdateDomainName operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateDomainName
*/
default UpdateDomainNameResponse updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Changes information about the DomainName resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateDomainNameRequest.Builder} avoiding the need
* to create one manually via {@link UpdateDomainNameRequest#builder()}
*
*
* @param updateDomainNameRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateDomainNameRequest.Builder} to create a
* request. A request to change information about the DomainName resource.
* @return Result of the UpdateDomainName operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateDomainName
*/
default UpdateDomainNameResponse updateDomainName(Consumer updateDomainNameRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return updateDomainName(UpdateDomainNameRequest.builder().applyMutation(updateDomainNameRequest).build());
}
/**
*
* Updates a GatewayResponse of a specified response type on the given RestApi.
*
*
* @param updateGatewayResponseRequest
* Updates a GatewayResponse of a specified response type on the given RestApi.
* @return Result of the UpdateGatewayResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateGatewayResponse
*/
default UpdateGatewayResponseResponse updateGatewayResponse(UpdateGatewayResponseRequest updateGatewayResponseRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a GatewayResponse of a specified response type on the given RestApi.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateGatewayResponseRequest.Builder} avoiding the
* need to create one manually via {@link UpdateGatewayResponseRequest#builder()}
*
*
* @param updateGatewayResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateGatewayResponseRequest.Builder} to create a
* request. Updates a GatewayResponse of a specified response type on the given RestApi.
* @return Result of the UpdateGatewayResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateGatewayResponse
*/
default UpdateGatewayResponseResponse updateGatewayResponse(
Consumer updateGatewayResponseRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return updateGatewayResponse(UpdateGatewayResponseRequest.builder().applyMutation(updateGatewayResponseRequest).build());
}
/**
*
* Represents an update integration.
*
*
* @param updateIntegrationRequest
* Represents an update integration request.
* @return Result of the UpdateIntegration operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateIntegration
*/
default UpdateIntegrationResponse updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Represents an update integration.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateIntegrationRequest.Builder} avoiding the need
* to create one manually via {@link UpdateIntegrationRequest#builder()}
*
*
* @param updateIntegrationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateIntegrationRequest.Builder} to create a
* request. Represents an update integration request.
* @return Result of the UpdateIntegration operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateIntegration
*/
default UpdateIntegrationResponse updateIntegration(Consumer updateIntegrationRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return updateIntegration(UpdateIntegrationRequest.builder().applyMutation(updateIntegrationRequest).build());
}
/**
*
* Represents an update integration response.
*
*
* @param updateIntegrationResponseRequest
* Represents an update integration response request.
* @return Result of the UpdateIntegrationResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateIntegrationResponse
*/
default UpdateIntegrationResponseResponse updateIntegrationResponse(
UpdateIntegrationResponseRequest updateIntegrationResponseRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Represents an update integration response.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateIntegrationResponseRequest.Builder} avoiding
* the need to create one manually via {@link UpdateIntegrationResponseRequest#builder()}
*
*
* @param updateIntegrationResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateIntegrationResponseRequest.Builder} to
* create a request. Represents an update integration response request.
* @return Result of the UpdateIntegrationResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateIntegrationResponse
*/
default UpdateIntegrationResponseResponse updateIntegrationResponse(
Consumer updateIntegrationResponseRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return updateIntegrationResponse(UpdateIntegrationResponseRequest.builder()
.applyMutation(updateIntegrationResponseRequest).build());
}
/**
*
* Updates an existing Method resource.
*
*
* @param updateMethodRequest
* Request to update an existing Method resource.
* @return Result of the UpdateMethod operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateMethod
*/
default UpdateMethodResponse updateMethod(UpdateMethodRequest updateMethodRequest) throws UnauthorizedException,
NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an existing Method resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateMethodRequest.Builder} avoiding the need to
* create one manually via {@link UpdateMethodRequest#builder()}
*
*
* @param updateMethodRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateMethodRequest.Builder} to create a request.
* Request to update an existing Method resource.
* @return Result of the UpdateMethod operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateMethod
*/
default UpdateMethodResponse updateMethod(Consumer updateMethodRequest)
throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return updateMethod(UpdateMethodRequest.builder().applyMutation(updateMethodRequest).build());
}
/**
*
* Updates an existing MethodResponse resource.
*
*
* @param updateMethodResponseRequest
* A request to update an existing MethodResponse resource.
* @return Result of the UpdateMethodResponse operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateMethodResponse
*/
default UpdateMethodResponseResponse updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)
throws UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, BadRequestException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an existing MethodResponse resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateMethodResponseRequest.Builder} avoiding the
* need to create one manually via {@link UpdateMethodResponseRequest#builder()}
*
*
* @param updateMethodResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateMethodResponseRequest.Builder} to create a
* request. A request to update an existing MethodResponse resource.
* @return Result of the UpdateMethodResponse operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateMethodResponse
*/
default UpdateMethodResponseResponse updateMethodResponse(
Consumer updateMethodResponseRequest) throws UnauthorizedException,
NotFoundException, ConflictException, LimitExceededException, BadRequestException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return updateMethodResponse(UpdateMethodResponseRequest.builder().applyMutation(updateMethodResponseRequest).build());
}
/**
*
* Changes information about a model. The maximum size of the model is 400 KB.
*
*
* @param updateModelRequest
* Request to update an existing model in an existing RestApi resource.
* @return Result of the UpdateModel operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateModel
*/
default UpdateModelResponse updateModel(UpdateModelRequest updateModelRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Changes information about a model. The maximum size of the model is 400 KB.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateModelRequest.Builder} avoiding the need to
* create one manually via {@link UpdateModelRequest#builder()}
*
*
* @param updateModelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateModelRequest.Builder} to create a request.
* Request to update an existing model in an existing RestApi resource.
* @return Result of the UpdateModel operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateModel
*/
default UpdateModelResponse updateModel(Consumer updateModelRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return updateModel(UpdateModelRequest.builder().applyMutation(updateModelRequest).build());
}
/**
*
* Updates a RequestValidator of a given RestApi.
*
*
* @param updateRequestValidatorRequest
* Updates a RequestValidator of a given RestApi.
* @return Result of the UpdateRequestValidator operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateRequestValidator
*/
default UpdateRequestValidatorResponse updateRequestValidator(UpdateRequestValidatorRequest updateRequestValidatorRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a RequestValidator of a given RestApi.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateRequestValidatorRequest.Builder} avoiding the
* need to create one manually via {@link UpdateRequestValidatorRequest#builder()}
*
*
* @param updateRequestValidatorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateRequestValidatorRequest.Builder} to create a
* request. Updates a RequestValidator of a given RestApi.
* @return Result of the UpdateRequestValidator operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateRequestValidator
*/
default UpdateRequestValidatorResponse updateRequestValidator(
Consumer updateRequestValidatorRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return updateRequestValidator(UpdateRequestValidatorRequest.builder().applyMutation(updateRequestValidatorRequest)
.build());
}
/**
*
* Changes information about a Resource resource.
*
*
* @param updateResourceRequest
* Request to change information about a Resource resource.
* @return Result of the UpdateResource operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateResource
*/
default UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest) throws UnauthorizedException,
NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Changes information about a Resource resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateResourceRequest.Builder} avoiding the need to
* create one manually via {@link UpdateResourceRequest#builder()}
*
*
* @param updateResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateResourceRequest.Builder} to create a
* request. Request to change information about a Resource resource.
* @return Result of the UpdateResource operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateResource
*/
default UpdateResourceResponse updateResource(Consumer updateResourceRequest)
throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return updateResource(UpdateResourceRequest.builder().applyMutation(updateResourceRequest).build());
}
/**
*
* Changes information about the specified API.
*
*
* @param updateRestApiRequest
* Request to update an existing RestApi resource in your collection.
* @return Result of the UpdateRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateRestApi
*/
default UpdateRestApiResponse updateRestApi(UpdateRestApiRequest updateRestApiRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Changes information about the specified API.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateRestApiRequest.Builder} avoiding the need to
* create one manually via {@link UpdateRestApiRequest#builder()}
*
*
* @param updateRestApiRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateRestApiRequest.Builder} to create a request.
* Request to update an existing RestApi resource in your collection.
* @return Result of the UpdateRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateRestApi
*/
default UpdateRestApiResponse updateRestApi(Consumer updateRestApiRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return updateRestApi(UpdateRestApiRequest.builder().applyMutation(updateRestApiRequest).build());
}
/**
*
* Changes information about a Stage resource.
*
*
* @param updateStageRequest
* Requests API Gateway to change information about a Stage resource.
* @return Result of the UpdateStage operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateStage
*/
default UpdateStageResponse updateStage(UpdateStageRequest updateStageRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Changes information about a Stage resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateStageRequest.Builder} avoiding the need to
* create one manually via {@link UpdateStageRequest#builder()}
*
*
* @param updateStageRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateStageRequest.Builder} to create a request.
* Requests API Gateway to change information about a Stage resource.
* @return Result of the UpdateStage operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateStage
*/
default UpdateStageResponse updateStage(Consumer updateStageRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return updateStage(UpdateStageRequest.builder().applyMutation(updateStageRequest).build());
}
/**
*
* Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
*
*
* @param updateUsageRequest
* The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a
* specified API key.
* @return Result of the UpdateUsage operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateUsage
*/
default UpdateUsageResponse updateUsage(UpdateUsageRequest updateUsageRequest) throws BadRequestException, ConflictException,
LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException, AwsServiceException,
SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateUsageRequest.Builder} avoiding the need to
* create one manually via {@link UpdateUsageRequest#builder()}
*
*
* @param updateUsageRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateUsageRequest.Builder} to create a request.
* The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a
* specified API key.
* @return Result of the UpdateUsage operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateUsage
*/
default UpdateUsageResponse updateUsage(Consumer updateUsageRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
return updateUsage(UpdateUsageRequest.builder().applyMutation(updateUsageRequest).build());
}
/**
*
* Updates a usage plan of a given plan Id.
*
*
* @param updateUsagePlanRequest
* The PATCH request to update a usage plan of a given plan Id.
* @return Result of the UpdateUsagePlan operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateUsagePlan
*/
default UpdateUsagePlanResponse updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a usage plan of a given plan Id.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateUsagePlanRequest.Builder} avoiding the need
* to create one manually via {@link UpdateUsagePlanRequest#builder()}
*
*
* @param updateUsagePlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateUsagePlanRequest.Builder} to create a
* request. The PATCH request to update a usage plan of a given plan Id.
* @return Result of the UpdateUsagePlan operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateUsagePlan
*/
default UpdateUsagePlanResponse updateUsagePlan(Consumer updateUsagePlanRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return updateUsagePlan(UpdateUsagePlanRequest.builder().applyMutation(updateUsagePlanRequest).build());
}
/**
*
* Updates an existing VpcLink of a specified identifier.
*
*
* @param updateVpcLinkRequest
* Updates an existing VpcLink of a specified identifier.
* @return Result of the UpdateVpcLink operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateVpcLink
*/
default UpdateVpcLinkResponse updateVpcLink(UpdateVpcLinkRequest updateVpcLinkRequest) throws BadRequestException,
ConflictException, LimitExceededException, NotFoundException, UnauthorizedException, TooManyRequestsException,
AwsServiceException, SdkClientException, ApiGatewayException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an existing VpcLink of a specified identifier.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateVpcLinkRequest.Builder} avoiding the need to
* create one manually via {@link UpdateVpcLinkRequest#builder()}
*
*
* @param updateVpcLinkRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.UpdateVpcLinkRequest.Builder} to create a request.
* Updates an existing VpcLink of a specified identifier.
* @return Result of the UpdateVpcLink operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ApiGatewayException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ApiGatewayClient.UpdateVpcLink
*/
default UpdateVpcLinkResponse updateVpcLink(Consumer updateVpcLinkRequest)
throws BadRequestException, ConflictException, LimitExceededException, NotFoundException, UnauthorizedException,
TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException {
return updateVpcLink(UpdateVpcLinkRequest.builder().applyMutation(updateVpcLinkRequest).build());
}
/**
* Create a {@link ApiGatewayClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static ApiGatewayClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link ApiGatewayClient}.
*/
static ApiGatewayClientBuilder builder() {
return new DefaultApiGatewayClientBuilder();
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
@Override
default ApiGatewayServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
}