Interface AppSyncClient
-
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface AppSyncClient extends AwsClient
Service client for accessing AWSAppSync. This can be created using the staticbuilder()
method.AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.
-
-
Field Summary
Fields Modifier and Type Field Description static String
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.static String
SERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
- Constant Field Values
-
-
Method Detail
-
associateApi
default AssociateApiResponse associateApi(AssociateApiRequest associateApiRequest) throws AccessDeniedException, BadRequestException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Maps an endpoint to your custom domain.
- Parameters:
associateApiRequest
-- Returns:
- Result of the AssociateApi operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
associateApi
default AssociateApiResponse associateApi(Consumer<AssociateApiRequest.Builder> associateApiRequest) throws AccessDeniedException, BadRequestException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Maps an endpoint to your custom domain.
This is a convenience which creates an instance of the
AssociateApiRequest.Builder
avoiding the need to create one manually viaAssociateApiRequest.builder()
- Parameters:
associateApiRequest
- AConsumer
that will call methods onAssociateApiRequest.Builder
to create a request.- Returns:
- Result of the AssociateApi operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
associateMergedGraphqlApi
default AssociateMergedGraphqlApiResponse associateMergedGraphqlApi(AssociateMergedGraphqlApiRequest associateMergedGraphqlApiRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, LimitExceededException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppSyncException
Creates an association between a Merged API and source API using the source API's identifier.
- Parameters:
associateMergedGraphqlApiRequest
-- Returns:
- Result of the AssociateMergedGraphqlApi operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
associateMergedGraphqlApi
default AssociateMergedGraphqlApiResponse associateMergedGraphqlApi(Consumer<AssociateMergedGraphqlApiRequest.Builder> associateMergedGraphqlApiRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, LimitExceededException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppSyncException
Creates an association between a Merged API and source API using the source API's identifier.
This is a convenience which creates an instance of the
AssociateMergedGraphqlApiRequest.Builder
avoiding the need to create one manually viaAssociateMergedGraphqlApiRequest.builder()
- Parameters:
associateMergedGraphqlApiRequest
- AConsumer
that will call methods onAssociateMergedGraphqlApiRequest.Builder
to create a request.- Returns:
- Result of the AssociateMergedGraphqlApi operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
associateSourceGraphqlApi
default AssociateSourceGraphqlApiResponse associateSourceGraphqlApi(AssociateSourceGraphqlApiRequest associateSourceGraphqlApiRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, LimitExceededException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppSyncException
Creates an association between a Merged API and source API using the Merged API's identifier.
- Parameters:
associateSourceGraphqlApiRequest
-- Returns:
- Result of the AssociateSourceGraphqlApi operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
associateSourceGraphqlApi
default AssociateSourceGraphqlApiResponse associateSourceGraphqlApi(Consumer<AssociateSourceGraphqlApiRequest.Builder> associateSourceGraphqlApiRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, LimitExceededException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppSyncException
Creates an association between a Merged API and source API using the Merged API's identifier.
This is a convenience which creates an instance of the
AssociateSourceGraphqlApiRequest.Builder
avoiding the need to create one manually viaAssociateSourceGraphqlApiRequest.builder()
- Parameters:
associateSourceGraphqlApiRequest
- AConsumer
that will call methods onAssociateSourceGraphqlApiRequest.Builder
to create a request.- Returns:
- Result of the AssociateSourceGraphqlApi operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createApi
default CreateApiResponse createApi(CreateApiRequest createApiRequest) throws BadRequestException, ConcurrentModificationException, UnauthorizedException, InternalFailureException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AppSyncException
Creates an
Api
object. Use this operation to create an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.- Parameters:
createApiRequest
-- Returns:
- Result of the CreateApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.ServiceQuotaExceededException
- The operation exceeded the service quota for this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createApi
default CreateApiResponse createApi(Consumer<CreateApiRequest.Builder> createApiRequest) throws BadRequestException, ConcurrentModificationException, UnauthorizedException, InternalFailureException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AppSyncException
Creates an
Api
object. Use this operation to create an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.
This is a convenience which creates an instance of the
CreateApiRequest.Builder
avoiding the need to create one manually viaCreateApiRequest.builder()
- Parameters:
createApiRequest
- AConsumer
that will call methods onCreateApiRequest.Builder
to create a request.- Returns:
- Result of the CreateApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.ServiceQuotaExceededException
- The operation exceeded the service quota for this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createApiCache
default CreateApiCacheResponse createApiCache(CreateApiCacheRequest createApiCacheRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Creates a cache for the GraphQL API.
- Parameters:
createApiCacheRequest
- Represents the input of aCreateApiCache
operation.- Returns:
- Result of the CreateApiCache operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createApiCache
default CreateApiCacheResponse createApiCache(Consumer<CreateApiCacheRequest.Builder> createApiCacheRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Creates a cache for the GraphQL API.
This is a convenience which creates an instance of the
CreateApiCacheRequest.Builder
avoiding the need to create one manually viaCreateApiCacheRequest.builder()
- Parameters:
createApiCacheRequest
- AConsumer
that will call methods onCreateApiCacheRequest.Builder
to create a request. Represents the input of aCreateApiCache
operation.- Returns:
- Result of the CreateApiCache operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createApiKey
default CreateApiKeyResponse createApiKey(CreateApiKeyRequest createApiKeyRequest) throws BadRequestException, NotFoundException, LimitExceededException, UnauthorizedException, InternalFailureException, ApiKeyLimitExceededException, ApiKeyValidityOutOfBoundsException, AwsServiceException, SdkClientException, AppSyncException
Creates a unique key that you can distribute to clients who invoke your API.
- Parameters:
createApiKeyRequest
-- Returns:
- Result of the CreateApiKey operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.UnauthorizedException
- You aren't authorized to perform this operation.LimitExceededException
- The request exceeded a limit. Try your request again.InternalFailureException
- An internal AppSync error occurred. Try your request again.ApiKeyLimitExceededException
- The API key exceeded a limit. Try your request again.ApiKeyValidityOutOfBoundsException
- The API key expiration must be set to a value between 1 and 365 days from creation (forCreateApiKey
) or from update (forUpdateApiKey
).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createApiKey
default CreateApiKeyResponse createApiKey(Consumer<CreateApiKeyRequest.Builder> createApiKeyRequest) throws BadRequestException, NotFoundException, LimitExceededException, UnauthorizedException, InternalFailureException, ApiKeyLimitExceededException, ApiKeyValidityOutOfBoundsException, AwsServiceException, SdkClientException, AppSyncException
Creates a unique key that you can distribute to clients who invoke your API.
This is a convenience which creates an instance of the
CreateApiKeyRequest.Builder
avoiding the need to create one manually viaCreateApiKeyRequest.builder()
- Parameters:
createApiKeyRequest
- AConsumer
that will call methods onCreateApiKeyRequest.Builder
to create a request.- Returns:
- Result of the CreateApiKey operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.UnauthorizedException
- You aren't authorized to perform this operation.LimitExceededException
- The request exceeded a limit. Try your request again.InternalFailureException
- An internal AppSync error occurred. Try your request again.ApiKeyLimitExceededException
- The API key exceeded a limit. Try your request again.ApiKeyValidityOutOfBoundsException
- The API key expiration must be set to a value between 1 and 365 days from creation (forCreateApiKey
) or from update (forUpdateApiKey
).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createChannelNamespace
default CreateChannelNamespaceResponse createChannelNamespace(CreateChannelNamespaceRequest createChannelNamespaceRequest) throws BadRequestException, ConcurrentModificationException, ConflictException, NotFoundException, UnauthorizedException, InternalFailureException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AppSyncException
Creates a
ChannelNamespace
for anApi
.- Parameters:
createChannelNamespaceRequest
-- Returns:
- Result of the CreateChannelNamespace operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.ConflictException
- A conflict with a previous successful update is detected. This typically occurs when the previous update did not have time to propagate before the next update was made. A retry (with appropriate backoff logic) is the recommended response to this exception.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.ServiceQuotaExceededException
- The operation exceeded the service quota for this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createChannelNamespace
default CreateChannelNamespaceResponse createChannelNamespace(Consumer<CreateChannelNamespaceRequest.Builder> createChannelNamespaceRequest) throws BadRequestException, ConcurrentModificationException, ConflictException, NotFoundException, UnauthorizedException, InternalFailureException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, AppSyncException
Creates a
ChannelNamespace
for anApi
.
This is a convenience which creates an instance of the
CreateChannelNamespaceRequest.Builder
avoiding the need to create one manually viaCreateChannelNamespaceRequest.builder()
- Parameters:
createChannelNamespaceRequest
- AConsumer
that will call methods onCreateChannelNamespaceRequest.Builder
to create a request.- Returns:
- Result of the CreateChannelNamespace operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.ConflictException
- A conflict with a previous successful update is detected. This typically occurs when the previous update did not have time to propagate before the next update was made. A retry (with appropriate backoff logic) is the recommended response to this exception.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.ServiceQuotaExceededException
- The operation exceeded the service quota for this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createDataSource
default CreateDataSourceResponse createDataSource(CreateDataSourceRequest createDataSourceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Creates a
DataSource
object.- Parameters:
createDataSourceRequest
-- Returns:
- Result of the CreateDataSource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createDataSource
default CreateDataSourceResponse createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Creates a
DataSource
object.
This is a convenience which creates an instance of the
CreateDataSourceRequest.Builder
avoiding the need to create one manually viaCreateDataSourceRequest.builder()
- Parameters:
createDataSourceRequest
- AConsumer
that will call methods onCreateDataSourceRequest.Builder
to create a request.- Returns:
- Result of the CreateDataSource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createDomainName
default CreateDomainNameResponse createDomainName(CreateDomainNameRequest createDomainNameRequest) throws AccessDeniedException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Creates a custom
DomainName
object.- Parameters:
createDomainNameRequest
-- Returns:
- Result of the CreateDomainName operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createDomainName
default CreateDomainNameResponse createDomainName(Consumer<CreateDomainNameRequest.Builder> createDomainNameRequest) throws AccessDeniedException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Creates a custom
DomainName
object.
This is a convenience which creates an instance of the
CreateDomainNameRequest.Builder
avoiding the need to create one manually viaCreateDomainNameRequest.builder()
- Parameters:
createDomainNameRequest
- AConsumer
that will call methods onCreateDomainNameRequest.Builder
to create a request.- Returns:
- Result of the CreateDomainName operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createFunction
default CreateFunctionResponse createFunction(CreateFunctionRequest createFunctionRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Creates a
Function
object.A function is a reusable entity. You can use multiple functions to compose the resolver logic.
- Parameters:
createFunctionRequest
-- Returns:
- Result of the CreateFunction operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createFunction
default CreateFunctionResponse createFunction(Consumer<CreateFunctionRequest.Builder> createFunctionRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Creates a
Function
object.A function is a reusable entity. You can use multiple functions to compose the resolver logic.
This is a convenience which creates an instance of the
CreateFunctionRequest.Builder
avoiding the need to create one manually viaCreateFunctionRequest.builder()
- Parameters:
createFunctionRequest
- AConsumer
that will call methods onCreateFunctionRequest.Builder
to create a request.- Returns:
- Result of the CreateFunction operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createGraphqlApi
default CreateGraphqlApiResponse createGraphqlApi(CreateGraphqlApiRequest createGraphqlApiRequest) throws BadRequestException, LimitExceededException, ConcurrentModificationException, UnauthorizedException, InternalFailureException, ApiLimitExceededException, AwsServiceException, SdkClientException, AppSyncException
Creates a
GraphqlApi
object.- Parameters:
createGraphqlApiRequest
-- Returns:
- Result of the CreateGraphqlApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.ApiLimitExceededException
- The GraphQL API exceeded a limit. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createGraphqlApi
default CreateGraphqlApiResponse createGraphqlApi(Consumer<CreateGraphqlApiRequest.Builder> createGraphqlApiRequest) throws BadRequestException, LimitExceededException, ConcurrentModificationException, UnauthorizedException, InternalFailureException, ApiLimitExceededException, AwsServiceException, SdkClientException, AppSyncException
Creates a
GraphqlApi
object.
This is a convenience which creates an instance of the
CreateGraphqlApiRequest.Builder
avoiding the need to create one manually viaCreateGraphqlApiRequest.builder()
- Parameters:
createGraphqlApiRequest
- AConsumer
that will call methods onCreateGraphqlApiRequest.Builder
to create a request.- Returns:
- Result of the CreateGraphqlApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.ApiLimitExceededException
- The GraphQL API exceeded a limit. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createResolver
default CreateResolverResponse createResolver(CreateResolverRequest createResolverRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Creates a
Resolver
object.A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL.
- Parameters:
createResolverRequest
-- Returns:
- Result of the CreateResolver operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createResolver
default CreateResolverResponse createResolver(Consumer<CreateResolverRequest.Builder> createResolverRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Creates a
Resolver
object.A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL.
This is a convenience which creates an instance of the
CreateResolverRequest.Builder
avoiding the need to create one manually viaCreateResolverRequest.builder()
- Parameters:
createResolverRequest
- AConsumer
that will call methods onCreateResolverRequest.Builder
to create a request.- Returns:
- Result of the CreateResolver operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createType
default CreateTypeResponse createType(CreateTypeRequest createTypeRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Creates a
Type
object.- Parameters:
createTypeRequest
-- Returns:
- Result of the CreateType operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createType
default CreateTypeResponse createType(Consumer<CreateTypeRequest.Builder> createTypeRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Creates a
Type
object.
This is a convenience which creates an instance of the
CreateTypeRequest.Builder
avoiding the need to create one manually viaCreateTypeRequest.builder()
- Parameters:
createTypeRequest
- AConsumer
that will call methods onCreateTypeRequest.Builder
to create a request.- Returns:
- Result of the CreateType operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteApi
default DeleteApiResponse deleteApi(DeleteApiRequest deleteApiRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Deletes an
Api
object- Parameters:
deleteApiRequest
-- Returns:
- Result of the DeleteApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteApi
default DeleteApiResponse deleteApi(Consumer<DeleteApiRequest.Builder> deleteApiRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Deletes an
Api
object
This is a convenience which creates an instance of the
DeleteApiRequest.Builder
avoiding the need to create one manually viaDeleteApiRequest.builder()
- Parameters:
deleteApiRequest
- AConsumer
that will call methods onDeleteApiRequest.Builder
to create a request.- Returns:
- Result of the DeleteApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteApiCache
default DeleteApiCacheResponse deleteApiCache(DeleteApiCacheRequest deleteApiCacheRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Deletes an
ApiCache
object.- Parameters:
deleteApiCacheRequest
- Represents the input of aDeleteApiCache
operation.- Returns:
- Result of the DeleteApiCache operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteApiCache
default DeleteApiCacheResponse deleteApiCache(Consumer<DeleteApiCacheRequest.Builder> deleteApiCacheRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Deletes an
ApiCache
object.
This is a convenience which creates an instance of the
DeleteApiCacheRequest.Builder
avoiding the need to create one manually viaDeleteApiCacheRequest.builder()
- Parameters:
deleteApiCacheRequest
- AConsumer
that will call methods onDeleteApiCacheRequest.Builder
to create a request. Represents the input of aDeleteApiCache
operation.- Returns:
- Result of the DeleteApiCache operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteApiKey
default DeleteApiKeyResponse deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Deletes an API key.
- Parameters:
deleteApiKeyRequest
-- Returns:
- Result of the DeleteApiKey operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteApiKey
default DeleteApiKeyResponse deleteApiKey(Consumer<DeleteApiKeyRequest.Builder> deleteApiKeyRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Deletes an API key.
This is a convenience which creates an instance of the
DeleteApiKeyRequest.Builder
avoiding the need to create one manually viaDeleteApiKeyRequest.builder()
- Parameters:
deleteApiKeyRequest
- AConsumer
that will call methods onDeleteApiKeyRequest.Builder
to create a request.- Returns:
- Result of the DeleteApiKey operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteChannelNamespace
default DeleteChannelNamespaceResponse deleteChannelNamespace(DeleteChannelNamespaceRequest deleteChannelNamespaceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Deletes a
ChannelNamespace
.- Parameters:
deleteChannelNamespaceRequest
-- Returns:
- Result of the DeleteChannelNamespace operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteChannelNamespace
default DeleteChannelNamespaceResponse deleteChannelNamespace(Consumer<DeleteChannelNamespaceRequest.Builder> deleteChannelNamespaceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Deletes a
ChannelNamespace
.
This is a convenience which creates an instance of the
DeleteChannelNamespaceRequest.Builder
avoiding the need to create one manually viaDeleteChannelNamespaceRequest.builder()
- Parameters:
deleteChannelNamespaceRequest
- AConsumer
that will call methods onDeleteChannelNamespaceRequest.Builder
to create a request.- Returns:
- Result of the DeleteChannelNamespace operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteDataSource
default DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Deletes a
DataSource
object.- Parameters:
deleteDataSourceRequest
-- Returns:
- Result of the DeleteDataSource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteDataSource
default DeleteDataSourceResponse deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Deletes a
DataSource
object.
This is a convenience which creates an instance of the
DeleteDataSourceRequest.Builder
avoiding the need to create one manually viaDeleteDataSourceRequest.builder()
- Parameters:
deleteDataSourceRequest
- AConsumer
that will call methods onDeleteDataSourceRequest.Builder
to create a request.- Returns:
- Result of the DeleteDataSource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteDomainName
default DeleteDomainNameResponse deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest) throws AccessDeniedException, BadRequestException, ConcurrentModificationException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Deletes a custom
DomainName
object.- Parameters:
deleteDomainNameRequest
-- Returns:
- Result of the DeleteDomainName operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteDomainName
default DeleteDomainNameResponse deleteDomainName(Consumer<DeleteDomainNameRequest.Builder> deleteDomainNameRequest) throws AccessDeniedException, BadRequestException, ConcurrentModificationException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Deletes a custom
DomainName
object.
This is a convenience which creates an instance of the
DeleteDomainNameRequest.Builder
avoiding the need to create one manually viaDeleteDomainNameRequest.builder()
- Parameters:
deleteDomainNameRequest
- AConsumer
that will call methods onDeleteDomainNameRequest.Builder
to create a request.- Returns:
- Result of the DeleteDomainName operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteFunction
default DeleteFunctionResponse deleteFunction(DeleteFunctionRequest deleteFunctionRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Deletes a
Function
.- Parameters:
deleteFunctionRequest
-- Returns:
- Result of the DeleteFunction operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteFunction
default DeleteFunctionResponse deleteFunction(Consumer<DeleteFunctionRequest.Builder> deleteFunctionRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Deletes a
Function
.
This is a convenience which creates an instance of the
DeleteFunctionRequest.Builder
avoiding the need to create one manually viaDeleteFunctionRequest.builder()
- Parameters:
deleteFunctionRequest
- AConsumer
that will call methods onDeleteFunctionRequest.Builder
to create a request.- Returns:
- Result of the DeleteFunction operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteGraphqlApi
default DeleteGraphqlApiResponse deleteGraphqlApi(DeleteGraphqlApiRequest deleteGraphqlApiRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Deletes a
GraphqlApi
object.- Parameters:
deleteGraphqlApiRequest
-- Returns:
- Result of the DeleteGraphqlApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteGraphqlApi
default DeleteGraphqlApiResponse deleteGraphqlApi(Consumer<DeleteGraphqlApiRequest.Builder> deleteGraphqlApiRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Deletes a
GraphqlApi
object.
This is a convenience which creates an instance of the
DeleteGraphqlApiRequest.Builder
avoiding the need to create one manually viaDeleteGraphqlApiRequest.builder()
- Parameters:
deleteGraphqlApiRequest
- AConsumer
that will call methods onDeleteGraphqlApiRequest.Builder
to create a request.- Returns:
- Result of the DeleteGraphqlApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteResolver
default DeleteResolverResponse deleteResolver(DeleteResolverRequest deleteResolverRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Deletes a
Resolver
object.- Parameters:
deleteResolverRequest
-- Returns:
- Result of the DeleteResolver operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteResolver
default DeleteResolverResponse deleteResolver(Consumer<DeleteResolverRequest.Builder> deleteResolverRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Deletes a
Resolver
object.
This is a convenience which creates an instance of the
DeleteResolverRequest.Builder
avoiding the need to create one manually viaDeleteResolverRequest.builder()
- Parameters:
deleteResolverRequest
- AConsumer
that will call methods onDeleteResolverRequest.Builder
to create a request.- Returns:
- Result of the DeleteResolver operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteType
default DeleteTypeResponse deleteType(DeleteTypeRequest deleteTypeRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Deletes a
Type
object.- Parameters:
deleteTypeRequest
-- Returns:
- Result of the DeleteType operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteType
default DeleteTypeResponse deleteType(Consumer<DeleteTypeRequest.Builder> deleteTypeRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Deletes a
Type
object.
This is a convenience which creates an instance of the
DeleteTypeRequest.Builder
avoiding the need to create one manually viaDeleteTypeRequest.builder()
- Parameters:
deleteTypeRequest
- AConsumer
that will call methods onDeleteTypeRequest.Builder
to create a request.- Returns:
- Result of the DeleteType operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
disassociateApi
default DisassociateApiResponse disassociateApi(DisassociateApiRequest disassociateApiRequest) throws AccessDeniedException, BadRequestException, ConcurrentModificationException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Removes an
ApiAssociation
object from a custom domain.- Parameters:
disassociateApiRequest
-- Returns:
- Result of the DisassociateApi operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
disassociateApi
default DisassociateApiResponse disassociateApi(Consumer<DisassociateApiRequest.Builder> disassociateApiRequest) throws AccessDeniedException, BadRequestException, ConcurrentModificationException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Removes an
ApiAssociation
object from a custom domain.
This is a convenience which creates an instance of the
DisassociateApiRequest.Builder
avoiding the need to create one manually viaDisassociateApiRequest.builder()
- Parameters:
disassociateApiRequest
- AConsumer
that will call methods onDisassociateApiRequest.Builder
to create a request.- Returns:
- Result of the DisassociateApi operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
disassociateMergedGraphqlApi
default DisassociateMergedGraphqlApiResponse disassociateMergedGraphqlApi(DisassociateMergedGraphqlApiRequest disassociateMergedGraphqlApiRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppSyncException
Deletes an association between a Merged API and source API using the source API's identifier and the association ID.
- Parameters:
disassociateMergedGraphqlApiRequest
-- Returns:
- Result of the DisassociateMergedGraphqlApi operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
disassociateMergedGraphqlApi
default DisassociateMergedGraphqlApiResponse disassociateMergedGraphqlApi(Consumer<DisassociateMergedGraphqlApiRequest.Builder> disassociateMergedGraphqlApiRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppSyncException
Deletes an association between a Merged API and source API using the source API's identifier and the association ID.
This is a convenience which creates an instance of the
DisassociateMergedGraphqlApiRequest.Builder
avoiding the need to create one manually viaDisassociateMergedGraphqlApiRequest.builder()
- Parameters:
disassociateMergedGraphqlApiRequest
- AConsumer
that will call methods onDisassociateMergedGraphqlApiRequest.Builder
to create a request.- Returns:
- Result of the DisassociateMergedGraphqlApi operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
disassociateSourceGraphqlApi
default DisassociateSourceGraphqlApiResponse disassociateSourceGraphqlApi(DisassociateSourceGraphqlApiRequest disassociateSourceGraphqlApiRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppSyncException
Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.
- Parameters:
disassociateSourceGraphqlApiRequest
-- Returns:
- Result of the DisassociateSourceGraphqlApi operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
disassociateSourceGraphqlApi
default DisassociateSourceGraphqlApiResponse disassociateSourceGraphqlApi(Consumer<DisassociateSourceGraphqlApiRequest.Builder> disassociateSourceGraphqlApiRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppSyncException
Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.
This is a convenience which creates an instance of the
DisassociateSourceGraphqlApiRequest.Builder
avoiding the need to create one manually viaDisassociateSourceGraphqlApiRequest.builder()
- Parameters:
disassociateSourceGraphqlApiRequest
- AConsumer
that will call methods onDisassociateSourceGraphqlApiRequest.Builder
to create a request.- Returns:
- Result of the DisassociateSourceGraphqlApi operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
evaluateCode
default EvaluateCodeResponse evaluateCode(EvaluateCodeRequest evaluateCodeRequest) throws AccessDeniedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For
APPSYNC_JS
runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type.- Parameters:
evaluateCodeRequest
-- Returns:
- Result of the EvaluateCode operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
evaluateCode
default EvaluateCodeResponse evaluateCode(Consumer<EvaluateCodeRequest.Builder> evaluateCodeRequest) throws AccessDeniedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For
APPSYNC_JS
runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type.
This is a convenience which creates an instance of the
EvaluateCodeRequest.Builder
avoiding the need to create one manually viaEvaluateCodeRequest.builder()
- Parameters:
evaluateCodeRequest
- AConsumer
that will call methods onEvaluateCodeRequest.Builder
to create a request.- Returns:
- Result of the EvaluateCode operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
evaluateMappingTemplate
default EvaluateMappingTemplateResponse evaluateMappingTemplate(EvaluateMappingTemplateRequest evaluateMappingTemplateRequest) throws AccessDeniedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Evaluates a given template and returns the response. The mapping template can be a request or response template.
Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type.
Mapping templates are written in the Apache Velocity Template Language (VTL).
- Parameters:
evaluateMappingTemplateRequest
-- Returns:
- Result of the EvaluateMappingTemplate operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
evaluateMappingTemplate
default EvaluateMappingTemplateResponse evaluateMappingTemplate(Consumer<EvaluateMappingTemplateRequest.Builder> evaluateMappingTemplateRequest) throws AccessDeniedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Evaluates a given template and returns the response. The mapping template can be a request or response template.
Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type.
Mapping templates are written in the Apache Velocity Template Language (VTL).
This is a convenience which creates an instance of the
EvaluateMappingTemplateRequest.Builder
avoiding the need to create one manually viaEvaluateMappingTemplateRequest.builder()
- Parameters:
evaluateMappingTemplateRequest
- AConsumer
that will call methods onEvaluateMappingTemplateRequest.Builder
to create a request.- Returns:
- Result of the EvaluateMappingTemplate operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
flushApiCache
default FlushApiCacheResponse flushApiCache(FlushApiCacheRequest flushApiCacheRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Flushes an
ApiCache
object.- Parameters:
flushApiCacheRequest
- Represents the input of aFlushApiCache
operation.- Returns:
- Result of the FlushApiCache operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
flushApiCache
default FlushApiCacheResponse flushApiCache(Consumer<FlushApiCacheRequest.Builder> flushApiCacheRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Flushes an
ApiCache
object.
This is a convenience which creates an instance of the
FlushApiCacheRequest.Builder
avoiding the need to create one manually viaFlushApiCacheRequest.builder()
- Parameters:
flushApiCacheRequest
- AConsumer
that will call methods onFlushApiCacheRequest.Builder
to create a request. Represents the input of aFlushApiCache
operation.- Returns:
- Result of the FlushApiCache operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getApi
default GetApiResponse getApi(GetApiRequest getApiRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Retrieves an
Api
object.- Parameters:
getApiRequest
-- Returns:
- Result of the GetApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getApi
default GetApiResponse getApi(Consumer<GetApiRequest.Builder> getApiRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Retrieves an
Api
object.
This is a convenience which creates an instance of the
GetApiRequest.Builder
avoiding the need to create one manually viaGetApiRequest.builder()
- Parameters:
getApiRequest
- AConsumer
that will call methods onGetApiRequest.Builder
to create a request.- Returns:
- Result of the GetApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getApiAssociation
default GetApiAssociationResponse getApiAssociation(GetApiAssociationRequest getApiAssociationRequest) throws AccessDeniedException, BadRequestException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Retrieves an
ApiAssociation
object.- Parameters:
getApiAssociationRequest
-- Returns:
- Result of the GetApiAssociation operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getApiAssociation
default GetApiAssociationResponse getApiAssociation(Consumer<GetApiAssociationRequest.Builder> getApiAssociationRequest) throws AccessDeniedException, BadRequestException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Retrieves an
ApiAssociation
object.
This is a convenience which creates an instance of the
GetApiAssociationRequest.Builder
avoiding the need to create one manually viaGetApiAssociationRequest.builder()
- Parameters:
getApiAssociationRequest
- AConsumer
that will call methods onGetApiAssociationRequest.Builder
to create a request.- Returns:
- Result of the GetApiAssociation operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getApiCache
default GetApiCacheResponse getApiCache(GetApiCacheRequest getApiCacheRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Retrieves an
ApiCache
object.- Parameters:
getApiCacheRequest
- Represents the input of aGetApiCache
operation.- Returns:
- Result of the GetApiCache operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getApiCache
default GetApiCacheResponse getApiCache(Consumer<GetApiCacheRequest.Builder> getApiCacheRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Retrieves an
ApiCache
object.
This is a convenience which creates an instance of the
GetApiCacheRequest.Builder
avoiding the need to create one manually viaGetApiCacheRequest.builder()
- Parameters:
getApiCacheRequest
- AConsumer
that will call methods onGetApiCacheRequest.Builder
to create a request. Represents the input of aGetApiCache
operation.- Returns:
- Result of the GetApiCache operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getChannelNamespace
default GetChannelNamespaceResponse getChannelNamespace(GetChannelNamespaceRequest getChannelNamespaceRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Retrieves the channel namespace for a specified
Api
.- Parameters:
getChannelNamespaceRequest
-- Returns:
- Result of the GetChannelNamespace operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getChannelNamespace
default GetChannelNamespaceResponse getChannelNamespace(Consumer<GetChannelNamespaceRequest.Builder> getChannelNamespaceRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Retrieves the channel namespace for a specified
Api
.
This is a convenience which creates an instance of the
GetChannelNamespaceRequest.Builder
avoiding the need to create one manually viaGetChannelNamespaceRequest.builder()
- Parameters:
getChannelNamespaceRequest
- AConsumer
that will call methods onGetChannelNamespaceRequest.Builder
to create a request.- Returns:
- Result of the GetChannelNamespace operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getDataSource
default GetDataSourceResponse getDataSource(GetDataSourceRequest getDataSourceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Retrieves a
DataSource
object.- Parameters:
getDataSourceRequest
-- Returns:
- Result of the GetDataSource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getDataSource
default GetDataSourceResponse getDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Retrieves a
DataSource
object.
This is a convenience which creates an instance of the
GetDataSourceRequest.Builder
avoiding the need to create one manually viaGetDataSourceRequest.builder()
- Parameters:
getDataSourceRequest
- AConsumer
that will call methods onGetDataSourceRequest.Builder
to create a request.- Returns:
- Result of the GetDataSource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getDataSourceIntrospection
default GetDataSourceIntrospectionResponse getDataSourceIntrospection(GetDataSourceIntrospectionRequest getDataSourceIntrospectionRequest) throws BadRequestException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.
- Parameters:
getDataSourceIntrospectionRequest
-- Returns:
- Result of the GetDataSourceIntrospection operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getDataSourceIntrospection
default GetDataSourceIntrospectionResponse getDataSourceIntrospection(Consumer<GetDataSourceIntrospectionRequest.Builder> getDataSourceIntrospectionRequest) throws BadRequestException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.
This is a convenience which creates an instance of the
GetDataSourceIntrospectionRequest.Builder
avoiding the need to create one manually viaGetDataSourceIntrospectionRequest.builder()
- Parameters:
getDataSourceIntrospectionRequest
- AConsumer
that will call methods onGetDataSourceIntrospectionRequest.Builder
to create a request.- Returns:
- Result of the GetDataSourceIntrospection operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getDomainName
default GetDomainNameResponse getDomainName(GetDomainNameRequest getDomainNameRequest) throws AccessDeniedException, BadRequestException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Retrieves a custom
DomainName
object.- Parameters:
getDomainNameRequest
-- Returns:
- Result of the GetDomainName operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getDomainName
default GetDomainNameResponse getDomainName(Consumer<GetDomainNameRequest.Builder> getDomainNameRequest) throws AccessDeniedException, BadRequestException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Retrieves a custom
DomainName
object.
This is a convenience which creates an instance of the
GetDomainNameRequest.Builder
avoiding the need to create one manually viaGetDomainNameRequest.builder()
- Parameters:
getDomainNameRequest
- AConsumer
that will call methods onGetDomainNameRequest.Builder
to create a request.- Returns:
- Result of the GetDomainName operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getFunction
default GetFunctionResponse getFunction(GetFunctionRequest getFunctionRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, AppSyncException
Get a
Function
.- Parameters:
getFunctionRequest
-- Returns:
- Result of the GetFunction operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getFunction
default GetFunctionResponse getFunction(Consumer<GetFunctionRequest.Builder> getFunctionRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, AppSyncException
Get a
Function
.
This is a convenience which creates an instance of the
GetFunctionRequest.Builder
avoiding the need to create one manually viaGetFunctionRequest.builder()
- Parameters:
getFunctionRequest
- AConsumer
that will call methods onGetFunctionRequest.Builder
to create a request.- Returns:
- Result of the GetFunction operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getGraphqlApi
default GetGraphqlApiResponse getGraphqlApi(GetGraphqlApiRequest getGraphqlApiRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Retrieves a
GraphqlApi
object.- Parameters:
getGraphqlApiRequest
-- Returns:
- Result of the GetGraphqlApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getGraphqlApi
default GetGraphqlApiResponse getGraphqlApi(Consumer<GetGraphqlApiRequest.Builder> getGraphqlApiRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Retrieves a
GraphqlApi
object.
This is a convenience which creates an instance of the
GetGraphqlApiRequest.Builder
avoiding the need to create one manually viaGetGraphqlApiRequest.builder()
- Parameters:
getGraphqlApiRequest
- AConsumer
that will call methods onGetGraphqlApiRequest.Builder
to create a request.- Returns:
- Result of the GetGraphqlApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getGraphqlApiEnvironmentVariables
default GetGraphqlApiEnvironmentVariablesResponse getGraphqlApiEnvironmentVariables(GetGraphqlApiEnvironmentVariablesRequest getGraphqlApiEnvironmentVariablesRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
- Parameters:
getGraphqlApiEnvironmentVariablesRequest
-- Returns:
- Result of the GetGraphqlApiEnvironmentVariables operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getGraphqlApiEnvironmentVariables
default GetGraphqlApiEnvironmentVariablesResponse getGraphqlApiEnvironmentVariables(Consumer<GetGraphqlApiEnvironmentVariablesRequest.Builder> getGraphqlApiEnvironmentVariablesRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
This is a convenience which creates an instance of the
GetGraphqlApiEnvironmentVariablesRequest.Builder
avoiding the need to create one manually viaGetGraphqlApiEnvironmentVariablesRequest.builder()
- Parameters:
getGraphqlApiEnvironmentVariablesRequest
- AConsumer
that will call methods onGetGraphqlApiEnvironmentVariablesRequest.Builder
to create a request.- Returns:
- Result of the GetGraphqlApiEnvironmentVariables operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getIntrospectionSchema
default GetIntrospectionSchemaResponse getIntrospectionSchema(GetIntrospectionSchemaRequest getIntrospectionSchemaRequest) throws GraphQlSchemaException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Retrieves the introspection schema for a GraphQL API.
- Parameters:
getIntrospectionSchemaRequest
-- Returns:
- Result of the GetIntrospectionSchema operation returned by the service.
- Throws:
GraphQlSchemaException
- The GraphQL schema is not valid.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getIntrospectionSchema
default GetIntrospectionSchemaResponse getIntrospectionSchema(Consumer<GetIntrospectionSchemaRequest.Builder> getIntrospectionSchemaRequest) throws GraphQlSchemaException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Retrieves the introspection schema for a GraphQL API.
This is a convenience which creates an instance of the
GetIntrospectionSchemaRequest.Builder
avoiding the need to create one manually viaGetIntrospectionSchemaRequest.builder()
- Parameters:
getIntrospectionSchemaRequest
- AConsumer
that will call methods onGetIntrospectionSchemaRequest.Builder
to create a request.- Returns:
- Result of the GetIntrospectionSchema operation returned by the service.
- Throws:
GraphQlSchemaException
- The GraphQL schema is not valid.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getResolver
default GetResolverResponse getResolver(GetResolverRequest getResolverRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, AppSyncException
Retrieves a
Resolver
object.- Parameters:
getResolverRequest
-- Returns:
- Result of the GetResolver operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getResolver
default GetResolverResponse getResolver(Consumer<GetResolverRequest.Builder> getResolverRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, AppSyncException
Retrieves a
Resolver
object.
This is a convenience which creates an instance of the
GetResolverRequest.Builder
avoiding the need to create one manually viaGetResolverRequest.builder()
- Parameters:
getResolverRequest
- AConsumer
that will call methods onGetResolverRequest.Builder
to create a request.- Returns:
- Result of the GetResolver operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getSchemaCreationStatus
default GetSchemaCreationStatusResponse getSchemaCreationStatus(GetSchemaCreationStatusRequest getSchemaCreationStatusRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Retrieves the current status of a schema creation operation.
- Parameters:
getSchemaCreationStatusRequest
-- Returns:
- Result of the GetSchemaCreationStatus operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getSchemaCreationStatus
default GetSchemaCreationStatusResponse getSchemaCreationStatus(Consumer<GetSchemaCreationStatusRequest.Builder> getSchemaCreationStatusRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Retrieves the current status of a schema creation operation.
This is a convenience which creates an instance of the
GetSchemaCreationStatusRequest.Builder
avoiding the need to create one manually viaGetSchemaCreationStatusRequest.builder()
- Parameters:
getSchemaCreationStatusRequest
- AConsumer
that will call methods onGetSchemaCreationStatusRequest.Builder
to create a request.- Returns:
- Result of the GetSchemaCreationStatus operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getSourceApiAssociation
default GetSourceApiAssociationResponse getSourceApiAssociation(GetSourceApiAssociationRequest getSourceApiAssociationRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Retrieves a
SourceApiAssociation
object.- Parameters:
getSourceApiAssociationRequest
-- Returns:
- Result of the GetSourceApiAssociation operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getSourceApiAssociation
default GetSourceApiAssociationResponse getSourceApiAssociation(Consumer<GetSourceApiAssociationRequest.Builder> getSourceApiAssociationRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Retrieves a
SourceApiAssociation
object.
This is a convenience which creates an instance of the
GetSourceApiAssociationRequest.Builder
avoiding the need to create one manually viaGetSourceApiAssociationRequest.builder()
- Parameters:
getSourceApiAssociationRequest
- AConsumer
that will call methods onGetSourceApiAssociationRequest.Builder
to create a request.- Returns:
- Result of the GetSourceApiAssociation operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getType
default GetTypeResponse getType(GetTypeRequest getTypeRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Retrieves a
Type
object.- Parameters:
getTypeRequest
-- Returns:
- Result of the GetType operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getType
default GetTypeResponse getType(Consumer<GetTypeRequest.Builder> getTypeRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Retrieves a
Type
object.
This is a convenience which creates an instance of the
GetTypeRequest.Builder
avoiding the need to create one manually viaGetTypeRequest.builder()
- Parameters:
getTypeRequest
- AConsumer
that will call methods onGetTypeRequest.Builder
to create a request.- Returns:
- Result of the GetType operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listApiKeys
default ListApiKeysResponse listApiKeys(ListApiKeysRequest listApiKeysRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists the API keys for a given API.
API keys are deleted automatically 60 days after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call
DeleteApiKey
to manually delete a key before it's automatically deleted.- Parameters:
listApiKeysRequest
-- Returns:
- Result of the ListApiKeys operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listApiKeys
default ListApiKeysResponse listApiKeys(Consumer<ListApiKeysRequest.Builder> listApiKeysRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists the API keys for a given API.
API keys are deleted automatically 60 days after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call
DeleteApiKey
to manually delete a key before it's automatically deleted.
This is a convenience which creates an instance of the
ListApiKeysRequest.Builder
avoiding the need to create one manually viaListApiKeysRequest.builder()
- Parameters:
listApiKeysRequest
- AConsumer
that will call methods onListApiKeysRequest.Builder
to create a request.- Returns:
- Result of the ListApiKeys operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listApiKeysPaginator
default ListApiKeysIterable listApiKeysPaginator(ListApiKeysRequest listApiKeysRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listApiKeys(software.amazon.awssdk.services.appsync.model.ListApiKeysRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListApiKeysIterable responses = client.listApiKeysPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListApiKeysIterable responses = client.listApiKeysPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListApiKeysResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListApiKeysIterable responses = client.listApiKeysPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listApiKeys(software.amazon.awssdk.services.appsync.model.ListApiKeysRequest)
operation.- Parameters:
listApiKeysRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listApiKeysPaginator
default ListApiKeysIterable listApiKeysPaginator(Consumer<ListApiKeysRequest.Builder> listApiKeysRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listApiKeys(software.amazon.awssdk.services.appsync.model.ListApiKeysRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListApiKeysIterable responses = client.listApiKeysPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListApiKeysIterable responses = client.listApiKeysPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListApiKeysResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListApiKeysIterable responses = client.listApiKeysPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listApiKeys(software.amazon.awssdk.services.appsync.model.ListApiKeysRequest)
operation.
This is a convenience which creates an instance of the
ListApiKeysRequest.Builder
avoiding the need to create one manually viaListApiKeysRequest.builder()
- Parameters:
listApiKeysRequest
- AConsumer
that will call methods onListApiKeysRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listApis
default ListApisResponse listApis(ListApisRequest listApisRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists the APIs in your AppSync account.
ListApis
returns only the high level API details. For more detailed information about an API, useGetApi
.- Parameters:
listApisRequest
-- Returns:
- Result of the ListApis operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listApis
default ListApisResponse listApis(Consumer<ListApisRequest.Builder> listApisRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists the APIs in your AppSync account.
ListApis
returns only the high level API details. For more detailed information about an API, useGetApi
.
This is a convenience which creates an instance of the
ListApisRequest.Builder
avoiding the need to create one manually viaListApisRequest.builder()
- Parameters:
listApisRequest
- AConsumer
that will call methods onListApisRequest.Builder
to create a request.- Returns:
- Result of the ListApis operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listApisPaginator
default ListApisIterable listApisPaginator(ListApisRequest listApisRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listApis(software.amazon.awssdk.services.appsync.model.ListApisRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListApisIterable responses = client.listApisPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListApisIterable responses = client.listApisPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListApisResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListApisIterable responses = client.listApisPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listApis(software.amazon.awssdk.services.appsync.model.ListApisRequest)
operation.- Parameters:
listApisRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listApisPaginator
default ListApisIterable listApisPaginator(Consumer<ListApisRequest.Builder> listApisRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listApis(software.amazon.awssdk.services.appsync.model.ListApisRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListApisIterable responses = client.listApisPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListApisIterable responses = client.listApisPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListApisResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListApisIterable responses = client.listApisPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listApis(software.amazon.awssdk.services.appsync.model.ListApisRequest)
operation.
This is a convenience which creates an instance of the
ListApisRequest.Builder
avoiding the need to create one manually viaListApisRequest.builder()
- Parameters:
listApisRequest
- AConsumer
that will call methods onListApisRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listChannelNamespaces
default ListChannelNamespacesResponse listChannelNamespaces(ListChannelNamespacesRequest listChannelNamespacesRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists the channel namespaces for a specified
Api
.ListChannelNamespaces
returns only high level details for the channel namespace. To retrieve code handlers, useGetChannelNamespace
.- Parameters:
listChannelNamespacesRequest
-- Returns:
- Result of the ListChannelNamespaces operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listChannelNamespaces
default ListChannelNamespacesResponse listChannelNamespaces(Consumer<ListChannelNamespacesRequest.Builder> listChannelNamespacesRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists the channel namespaces for a specified
Api
.ListChannelNamespaces
returns only high level details for the channel namespace. To retrieve code handlers, useGetChannelNamespace
.
This is a convenience which creates an instance of the
ListChannelNamespacesRequest.Builder
avoiding the need to create one manually viaListChannelNamespacesRequest.builder()
- Parameters:
listChannelNamespacesRequest
- AConsumer
that will call methods onListChannelNamespacesRequest.Builder
to create a request.- Returns:
- Result of the ListChannelNamespaces operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listChannelNamespacesPaginator
default ListChannelNamespacesIterable listChannelNamespacesPaginator(ListChannelNamespacesRequest listChannelNamespacesRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listChannelNamespaces(software.amazon.awssdk.services.appsync.model.ListChannelNamespacesRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListChannelNamespacesIterable responses = client.listChannelNamespacesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListChannelNamespacesIterable responses = client .listChannelNamespacesPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListChannelNamespacesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListChannelNamespacesIterable responses = client.listChannelNamespacesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listChannelNamespaces(software.amazon.awssdk.services.appsync.model.ListChannelNamespacesRequest)
operation.- Parameters:
listChannelNamespacesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listChannelNamespacesPaginator
default ListChannelNamespacesIterable listChannelNamespacesPaginator(Consumer<ListChannelNamespacesRequest.Builder> listChannelNamespacesRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listChannelNamespaces(software.amazon.awssdk.services.appsync.model.ListChannelNamespacesRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListChannelNamespacesIterable responses = client.listChannelNamespacesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListChannelNamespacesIterable responses = client .listChannelNamespacesPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListChannelNamespacesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListChannelNamespacesIterable responses = client.listChannelNamespacesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listChannelNamespaces(software.amazon.awssdk.services.appsync.model.ListChannelNamespacesRequest)
operation.
This is a convenience which creates an instance of the
ListChannelNamespacesRequest.Builder
avoiding the need to create one manually viaListChannelNamespacesRequest.builder()
- Parameters:
listChannelNamespacesRequest
- AConsumer
that will call methods onListChannelNamespacesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDataSources
default ListDataSourcesResponse listDataSources(ListDataSourcesRequest listDataSourcesRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists the data sources for a given API.
- Parameters:
listDataSourcesRequest
-- Returns:
- Result of the ListDataSources operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDataSources
default ListDataSourcesResponse listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists the data sources for a given API.
This is a convenience which creates an instance of the
ListDataSourcesRequest.Builder
avoiding the need to create one manually viaListDataSourcesRequest.builder()
- Parameters:
listDataSourcesRequest
- AConsumer
that will call methods onListDataSourcesRequest.Builder
to create a request.- Returns:
- Result of the ListDataSources operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDataSourcesPaginator
default ListDataSourcesIterable listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listDataSources(software.amazon.awssdk.services.appsync.model.ListDataSourcesRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListDataSourcesIterable responses = client .listDataSourcesPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListDataSourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listDataSources(software.amazon.awssdk.services.appsync.model.ListDataSourcesRequest)
operation.- Parameters:
listDataSourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDataSourcesPaginator
default ListDataSourcesIterable listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listDataSources(software.amazon.awssdk.services.appsync.model.ListDataSourcesRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListDataSourcesIterable responses = client .listDataSourcesPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListDataSourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listDataSources(software.amazon.awssdk.services.appsync.model.ListDataSourcesRequest)
operation.
This is a convenience which creates an instance of the
ListDataSourcesRequest.Builder
avoiding the need to create one manually viaListDataSourcesRequest.builder()
- Parameters:
listDataSourcesRequest
- AConsumer
that will call methods onListDataSourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDomainNames
default ListDomainNamesResponse listDomainNames(ListDomainNamesRequest listDomainNamesRequest) throws AccessDeniedException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists multiple custom domain names.
- Parameters:
listDomainNamesRequest
-- Returns:
- Result of the ListDomainNames operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDomainNames
default ListDomainNamesResponse listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest) throws AccessDeniedException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists multiple custom domain names.
This is a convenience which creates an instance of the
ListDomainNamesRequest.Builder
avoiding the need to create one manually viaListDomainNamesRequest.builder()
- Parameters:
listDomainNamesRequest
- AConsumer
that will call methods onListDomainNamesRequest.Builder
to create a request.- Returns:
- Result of the ListDomainNames operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDomainNamesPaginator
default ListDomainNamesIterable listDomainNamesPaginator(ListDomainNamesRequest listDomainNamesRequest) throws AccessDeniedException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listDomainNames(software.amazon.awssdk.services.appsync.model.ListDomainNamesRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListDomainNamesIterable responses = client.listDomainNamesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListDomainNamesIterable responses = client .listDomainNamesPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListDomainNamesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListDomainNamesIterable responses = client.listDomainNamesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listDomainNames(software.amazon.awssdk.services.appsync.model.ListDomainNamesRequest)
operation.- Parameters:
listDomainNamesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDomainNamesPaginator
default ListDomainNamesIterable listDomainNamesPaginator(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest) throws AccessDeniedException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listDomainNames(software.amazon.awssdk.services.appsync.model.ListDomainNamesRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListDomainNamesIterable responses = client.listDomainNamesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListDomainNamesIterable responses = client .listDomainNamesPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListDomainNamesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListDomainNamesIterable responses = client.listDomainNamesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listDomainNames(software.amazon.awssdk.services.appsync.model.ListDomainNamesRequest)
operation.
This is a convenience which creates an instance of the
ListDomainNamesRequest.Builder
avoiding the need to create one manually viaListDomainNamesRequest.builder()
- Parameters:
listDomainNamesRequest
- AConsumer
that will call methods onListDomainNamesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listFunctions
default ListFunctionsResponse listFunctions(ListFunctionsRequest listFunctionsRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
List multiple functions.
- Parameters:
listFunctionsRequest
-- Returns:
- Result of the ListFunctions operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listFunctions
default ListFunctionsResponse listFunctions(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
List multiple functions.
This is a convenience which creates an instance of the
ListFunctionsRequest.Builder
avoiding the need to create one manually viaListFunctionsRequest.builder()
- Parameters:
listFunctionsRequest
- AConsumer
that will call methods onListFunctionsRequest.Builder
to create a request.- Returns:
- Result of the ListFunctions operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listFunctionsPaginator
default ListFunctionsIterable listFunctionsPaginator(ListFunctionsRequest listFunctionsRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listFunctions(software.amazon.awssdk.services.appsync.model.ListFunctionsRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListFunctionsIterable responses = client.listFunctionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListFunctionsIterable responses = client.listFunctionsPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListFunctionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListFunctionsIterable responses = client.listFunctionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listFunctions(software.amazon.awssdk.services.appsync.model.ListFunctionsRequest)
operation.- Parameters:
listFunctionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listFunctionsPaginator
default ListFunctionsIterable listFunctionsPaginator(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listFunctions(software.amazon.awssdk.services.appsync.model.ListFunctionsRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListFunctionsIterable responses = client.listFunctionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListFunctionsIterable responses = client.listFunctionsPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListFunctionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListFunctionsIterable responses = client.listFunctionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listFunctions(software.amazon.awssdk.services.appsync.model.ListFunctionsRequest)
operation.
This is a convenience which creates an instance of the
ListFunctionsRequest.Builder
avoiding the need to create one manually viaListFunctionsRequest.builder()
- Parameters:
listFunctionsRequest
- AConsumer
that will call methods onListFunctionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listGraphqlApis
default ListGraphqlApisResponse listGraphqlApis(ListGraphqlApisRequest listGraphqlApisRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists your GraphQL APIs.
- Parameters:
listGraphqlApisRequest
-- Returns:
- Result of the ListGraphqlApis operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listGraphqlApis
default ListGraphqlApisResponse listGraphqlApis(Consumer<ListGraphqlApisRequest.Builder> listGraphqlApisRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists your GraphQL APIs.
This is a convenience which creates an instance of the
ListGraphqlApisRequest.Builder
avoiding the need to create one manually viaListGraphqlApisRequest.builder()
- Parameters:
listGraphqlApisRequest
- AConsumer
that will call methods onListGraphqlApisRequest.Builder
to create a request.- Returns:
- Result of the ListGraphqlApis operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listGraphqlApis
default ListGraphqlApisResponse listGraphqlApis() throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists your GraphQL APIs.
- Returns:
- Result of the ListGraphqlApis operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listGraphqlApis(ListGraphqlApisRequest)
, AWS API Documentation
-
listGraphqlApisPaginator
default ListGraphqlApisIterable listGraphqlApisPaginator() throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listGraphqlApis(software.amazon.awssdk.services.appsync.model.ListGraphqlApisRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListGraphqlApisIterable responses = client.listGraphqlApisPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListGraphqlApisIterable responses = client .listGraphqlApisPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListGraphqlApisResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListGraphqlApisIterable responses = client.listGraphqlApisPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listGraphqlApis(software.amazon.awssdk.services.appsync.model.ListGraphqlApisRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listGraphqlApisPaginator(ListGraphqlApisRequest)
, AWS API Documentation
-
listGraphqlApisPaginator
default ListGraphqlApisIterable listGraphqlApisPaginator(ListGraphqlApisRequest listGraphqlApisRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listGraphqlApis(software.amazon.awssdk.services.appsync.model.ListGraphqlApisRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListGraphqlApisIterable responses = client.listGraphqlApisPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListGraphqlApisIterable responses = client .listGraphqlApisPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListGraphqlApisResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListGraphqlApisIterable responses = client.listGraphqlApisPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listGraphqlApis(software.amazon.awssdk.services.appsync.model.ListGraphqlApisRequest)
operation.- Parameters:
listGraphqlApisRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listGraphqlApisPaginator
default ListGraphqlApisIterable listGraphqlApisPaginator(Consumer<ListGraphqlApisRequest.Builder> listGraphqlApisRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listGraphqlApis(software.amazon.awssdk.services.appsync.model.ListGraphqlApisRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListGraphqlApisIterable responses = client.listGraphqlApisPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListGraphqlApisIterable responses = client .listGraphqlApisPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListGraphqlApisResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListGraphqlApisIterable responses = client.listGraphqlApisPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listGraphqlApis(software.amazon.awssdk.services.appsync.model.ListGraphqlApisRequest)
operation.
This is a convenience which creates an instance of the
ListGraphqlApisRequest.Builder
avoiding the need to create one manually viaListGraphqlApisRequest.builder()
- Parameters:
listGraphqlApisRequest
- AConsumer
that will call methods onListGraphqlApisRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listResolvers
default ListResolversResponse listResolvers(ListResolversRequest listResolversRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists the resolvers for a given API and type.
- Parameters:
listResolversRequest
-- Returns:
- Result of the ListResolvers operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listResolvers
default ListResolversResponse listResolvers(Consumer<ListResolversRequest.Builder> listResolversRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists the resolvers for a given API and type.
This is a convenience which creates an instance of the
ListResolversRequest.Builder
avoiding the need to create one manually viaListResolversRequest.builder()
- Parameters:
listResolversRequest
- AConsumer
that will call methods onListResolversRequest.Builder
to create a request.- Returns:
- Result of the ListResolvers operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listResolversPaginator
default ListResolversIterable listResolversPaginator(ListResolversRequest listResolversRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listResolvers(software.amazon.awssdk.services.appsync.model.ListResolversRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListResolversIterable responses = client.listResolversPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListResolversIterable responses = client.listResolversPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListResolversResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListResolversIterable responses = client.listResolversPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listResolvers(software.amazon.awssdk.services.appsync.model.ListResolversRequest)
operation.- Parameters:
listResolversRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listResolversPaginator
default ListResolversIterable listResolversPaginator(Consumer<ListResolversRequest.Builder> listResolversRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listResolvers(software.amazon.awssdk.services.appsync.model.ListResolversRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListResolversIterable responses = client.listResolversPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListResolversIterable responses = client.listResolversPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListResolversResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListResolversIterable responses = client.listResolversPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listResolvers(software.amazon.awssdk.services.appsync.model.ListResolversRequest)
operation.
This is a convenience which creates an instance of the
ListResolversRequest.Builder
avoiding the need to create one manually viaListResolversRequest.builder()
- Parameters:
listResolversRequest
- AConsumer
that will call methods onListResolversRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listResolversByFunction
default ListResolversByFunctionResponse listResolversByFunction(ListResolversByFunctionRequest listResolversByFunctionRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
List the resolvers that are associated with a specific function.
- Parameters:
listResolversByFunctionRequest
-- Returns:
- Result of the ListResolversByFunction operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listResolversByFunction
default ListResolversByFunctionResponse listResolversByFunction(Consumer<ListResolversByFunctionRequest.Builder> listResolversByFunctionRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
List the resolvers that are associated with a specific function.
This is a convenience which creates an instance of the
ListResolversByFunctionRequest.Builder
avoiding the need to create one manually viaListResolversByFunctionRequest.builder()
- Parameters:
listResolversByFunctionRequest
- AConsumer
that will call methods onListResolversByFunctionRequest.Builder
to create a request.- Returns:
- Result of the ListResolversByFunction operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listResolversByFunctionPaginator
default ListResolversByFunctionIterable listResolversByFunctionPaginator(ListResolversByFunctionRequest listResolversByFunctionRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listResolversByFunction(software.amazon.awssdk.services.appsync.model.ListResolversByFunctionRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListResolversByFunctionIterable responses = client.listResolversByFunctionPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListResolversByFunctionIterable responses = client .listResolversByFunctionPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListResolversByFunctionResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListResolversByFunctionIterable responses = client.listResolversByFunctionPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listResolversByFunction(software.amazon.awssdk.services.appsync.model.ListResolversByFunctionRequest)
operation.- Parameters:
listResolversByFunctionRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listResolversByFunctionPaginator
default ListResolversByFunctionIterable listResolversByFunctionPaginator(Consumer<ListResolversByFunctionRequest.Builder> listResolversByFunctionRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listResolversByFunction(software.amazon.awssdk.services.appsync.model.ListResolversByFunctionRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListResolversByFunctionIterable responses = client.listResolversByFunctionPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListResolversByFunctionIterable responses = client .listResolversByFunctionPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListResolversByFunctionResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListResolversByFunctionIterable responses = client.listResolversByFunctionPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listResolversByFunction(software.amazon.awssdk.services.appsync.model.ListResolversByFunctionRequest)
operation.
This is a convenience which creates an instance of the
ListResolversByFunctionRequest.Builder
avoiding the need to create one manually viaListResolversByFunctionRequest.builder()
- Parameters:
listResolversByFunctionRequest
- AConsumer
that will call methods onListResolversByFunctionRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listSourceApiAssociations
default ListSourceApiAssociationsResponse listSourceApiAssociations(ListSourceApiAssociationsRequest listSourceApiAssociationsRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Lists the
SourceApiAssociationSummary
data.- Parameters:
listSourceApiAssociationsRequest
-- Returns:
- Result of the ListSourceApiAssociations operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listSourceApiAssociations
default ListSourceApiAssociationsResponse listSourceApiAssociations(Consumer<ListSourceApiAssociationsRequest.Builder> listSourceApiAssociationsRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Lists the
SourceApiAssociationSummary
data.
This is a convenience which creates an instance of the
ListSourceApiAssociationsRequest.Builder
avoiding the need to create one manually viaListSourceApiAssociationsRequest.builder()
- Parameters:
listSourceApiAssociationsRequest
- AConsumer
that will call methods onListSourceApiAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ListSourceApiAssociations operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listSourceApiAssociationsPaginator
default ListSourceApiAssociationsIterable listSourceApiAssociationsPaginator(ListSourceApiAssociationsRequest listSourceApiAssociationsRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listSourceApiAssociations(software.amazon.awssdk.services.appsync.model.ListSourceApiAssociationsRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListSourceApiAssociationsIterable responses = client.listSourceApiAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListSourceApiAssociationsIterable responses = client .listSourceApiAssociationsPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListSourceApiAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListSourceApiAssociationsIterable responses = client.listSourceApiAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listSourceApiAssociations(software.amazon.awssdk.services.appsync.model.ListSourceApiAssociationsRequest)
operation.- Parameters:
listSourceApiAssociationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listSourceApiAssociationsPaginator
default ListSourceApiAssociationsIterable listSourceApiAssociationsPaginator(Consumer<ListSourceApiAssociationsRequest.Builder> listSourceApiAssociationsRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listSourceApiAssociations(software.amazon.awssdk.services.appsync.model.ListSourceApiAssociationsRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListSourceApiAssociationsIterable responses = client.listSourceApiAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListSourceApiAssociationsIterable responses = client .listSourceApiAssociationsPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListSourceApiAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListSourceApiAssociationsIterable responses = client.listSourceApiAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listSourceApiAssociations(software.amazon.awssdk.services.appsync.model.ListSourceApiAssociationsRequest)
operation.
This is a convenience which creates an instance of the
ListSourceApiAssociationsRequest.Builder
avoiding the need to create one manually viaListSourceApiAssociationsRequest.builder()
- Parameters:
listSourceApiAssociationsRequest
- AConsumer
that will call methods onListSourceApiAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, NotFoundException, LimitExceededException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Lists the tags for a resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, NotFoundException, LimitExceededException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Lists the tags for a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTypes
default ListTypesResponse listTypes(ListTypesRequest listTypesRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists the types for a given API.
- Parameters:
listTypesRequest
-- Returns:
- Result of the ListTypes operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTypes
default ListTypesResponse listTypes(Consumer<ListTypesRequest.Builder> listTypesRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists the types for a given API.
This is a convenience which creates an instance of the
ListTypesRequest.Builder
avoiding the need to create one manually viaListTypesRequest.builder()
- Parameters:
listTypesRequest
- AConsumer
that will call methods onListTypesRequest.Builder
to create a request.- Returns:
- Result of the ListTypes operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTypesPaginator
default ListTypesIterable listTypesPaginator(ListTypesRequest listTypesRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listTypes(software.amazon.awssdk.services.appsync.model.ListTypesRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListTypesIterable responses = client.listTypesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListTypesIterable responses = client.listTypesPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListTypesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListTypesIterable responses = client.listTypesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listTypes(software.amazon.awssdk.services.appsync.model.ListTypesRequest)
operation.- Parameters:
listTypesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTypesPaginator
default ListTypesIterable listTypesPaginator(Consumer<ListTypesRequest.Builder> listTypesRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listTypes(software.amazon.awssdk.services.appsync.model.ListTypesRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListTypesIterable responses = client.listTypesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListTypesIterable responses = client.listTypesPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListTypesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListTypesIterable responses = client.listTypesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listTypes(software.amazon.awssdk.services.appsync.model.ListTypesRequest)
operation.
This is a convenience which creates an instance of the
ListTypesRequest.Builder
avoiding the need to create one manually viaListTypesRequest.builder()
- Parameters:
listTypesRequest
- AConsumer
that will call methods onListTypesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTypesByAssociation
default ListTypesByAssociationResponse listTypesByAssociation(ListTypesByAssociationRequest listTypesByAssociationRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists
Type
objects by the source API association ID.- Parameters:
listTypesByAssociationRequest
-- Returns:
- Result of the ListTypesByAssociation operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTypesByAssociation
default ListTypesByAssociationResponse listTypesByAssociation(Consumer<ListTypesByAssociationRequest.Builder> listTypesByAssociationRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Lists
Type
objects by the source API association ID.
This is a convenience which creates an instance of the
ListTypesByAssociationRequest.Builder
avoiding the need to create one manually viaListTypesByAssociationRequest.builder()
- Parameters:
listTypesByAssociationRequest
- AConsumer
that will call methods onListTypesByAssociationRequest.Builder
to create a request.- Returns:
- Result of the ListTypesByAssociation operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTypesByAssociationPaginator
default ListTypesByAssociationIterable listTypesByAssociationPaginator(ListTypesByAssociationRequest listTypesByAssociationRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listTypesByAssociation(software.amazon.awssdk.services.appsync.model.ListTypesByAssociationRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListTypesByAssociationIterable responses = client.listTypesByAssociationPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListTypesByAssociationIterable responses = client .listTypesByAssociationPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListTypesByAssociationResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListTypesByAssociationIterable responses = client.listTypesByAssociationPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listTypesByAssociation(software.amazon.awssdk.services.appsync.model.ListTypesByAssociationRequest)
operation.- Parameters:
listTypesByAssociationRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTypesByAssociationPaginator
default ListTypesByAssociationIterable listTypesByAssociationPaginator(Consumer<ListTypesByAssociationRequest.Builder> listTypesByAssociationRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
This is a variant of
listTypesByAssociation(software.amazon.awssdk.services.appsync.model.ListTypesByAssociationRequest)
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 Streamsoftware.amazon.awssdk.services.appsync.paginators.ListTypesByAssociationIterable responses = client.listTypesByAssociationPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appsync.paginators.ListTypesByAssociationIterable responses = client .listTypesByAssociationPaginator(request); for (software.amazon.awssdk.services.appsync.model.ListTypesByAssociationResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appsync.paginators.ListTypesByAssociationIterable responses = client.listTypesByAssociationPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults 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
listTypesByAssociation(software.amazon.awssdk.services.appsync.model.ListTypesByAssociationRequest)
operation.
This is a convenience which creates an instance of the
ListTypesByAssociationRequest.Builder
avoiding the need to create one manually viaListTypesByAssociationRequest.builder()
- Parameters:
listTypesByAssociationRequest
- AConsumer
that will call methods onListTypesByAssociationRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
putGraphqlApiEnvironmentVariables
default PutGraphqlApiEnvironmentVariablesResponse putGraphqlApiEnvironmentVariables(PutGraphqlApiEnvironmentVariablesRequest putGraphqlApiEnvironmentVariablesRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Creates a list of environmental variables in an API by its ID value.
When creating an environmental variable, it must follow the constraints below:
-
Both JavaScript and VTL templates support environmental variables.
-
Environmental variables are not evaluated before function invocation.
-
Environmental variables only support string values.
-
Any defined value in an environmental variable is considered a string literal and not expanded.
-
Variable evaluations should ideally be performed in the function code.
When creating an environmental variable key-value pair, it must follow the additional constraints below:
-
Keys must begin with a letter.
-
Keys must be at least two characters long.
-
Keys can only contain letters, numbers, and the underscore character (_).
-
Values can be up to 512 characters long.
-
You can configure up to 50 key-value pairs in a GraphQL API.
You can create a list of environmental variables by adding it to the
environmentVariables
payload as a list in the format{"key1":"value1","key2":"value2", …}
. Note that each call of thePutGraphqlApiEnvironmentVariables
action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action.- Parameters:
putGraphqlApiEnvironmentVariablesRequest
-- Returns:
- Result of the PutGraphqlApiEnvironmentVariables operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
putGraphqlApiEnvironmentVariables
default PutGraphqlApiEnvironmentVariablesResponse putGraphqlApiEnvironmentVariables(Consumer<PutGraphqlApiEnvironmentVariablesRequest.Builder> putGraphqlApiEnvironmentVariablesRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Creates a list of environmental variables in an API by its ID value.
When creating an environmental variable, it must follow the constraints below:
-
Both JavaScript and VTL templates support environmental variables.
-
Environmental variables are not evaluated before function invocation.
-
Environmental variables only support string values.
-
Any defined value in an environmental variable is considered a string literal and not expanded.
-
Variable evaluations should ideally be performed in the function code.
When creating an environmental variable key-value pair, it must follow the additional constraints below:
-
Keys must begin with a letter.
-
Keys must be at least two characters long.
-
Keys can only contain letters, numbers, and the underscore character (_).
-
Values can be up to 512 characters long.
-
You can configure up to 50 key-value pairs in a GraphQL API.
You can create a list of environmental variables by adding it to the
environmentVariables
payload as a list in the format{"key1":"value1","key2":"value2", …}
. Note that each call of thePutGraphqlApiEnvironmentVariables
action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action.
This is a convenience which creates an instance of the
PutGraphqlApiEnvironmentVariablesRequest.Builder
avoiding the need to create one manually viaPutGraphqlApiEnvironmentVariablesRequest.builder()
- Parameters:
putGraphqlApiEnvironmentVariablesRequest
- AConsumer
that will call methods onPutGraphqlApiEnvironmentVariablesRequest.Builder
to create a request.- Returns:
- Result of the PutGraphqlApiEnvironmentVariables operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
startDataSourceIntrospection
default StartDataSourceIntrospectionResponse startDataSourceIntrospection(StartDataSourceIntrospectionRequest startDataSourceIntrospectionRequest) throws NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Creates a new introspection. Returns the
introspectionId
of the new introspection after its creation.- Parameters:
startDataSourceIntrospectionRequest
-- Returns:
- Result of the StartDataSourceIntrospection operation returned by the service.
- Throws:
NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startDataSourceIntrospection
default StartDataSourceIntrospectionResponse startDataSourceIntrospection(Consumer<StartDataSourceIntrospectionRequest.Builder> startDataSourceIntrospectionRequest) throws NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Creates a new introspection. Returns the
introspectionId
of the new introspection after its creation.
This is a convenience which creates an instance of the
StartDataSourceIntrospectionRequest.Builder
avoiding the need to create one manually viaStartDataSourceIntrospectionRequest.builder()
- Parameters:
startDataSourceIntrospectionRequest
- AConsumer
that will call methods onStartDataSourceIntrospectionRequest.Builder
to create a request.- Returns:
- Result of the StartDataSourceIntrospection operation returned by the service.
- Throws:
NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startSchemaCreation
default StartSchemaCreationResponse startSchemaCreation(StartSchemaCreationRequest startSchemaCreationRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Adds a new schema to your GraphQL API.
This operation is asynchronous. Use to determine when it has completed.
- Parameters:
startSchemaCreationRequest
-- Returns:
- Result of the StartSchemaCreation operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startSchemaCreation
default StartSchemaCreationResponse startSchemaCreation(Consumer<StartSchemaCreationRequest.Builder> startSchemaCreationRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Adds a new schema to your GraphQL API.
This operation is asynchronous. Use to determine when it has completed.
This is a convenience which creates an instance of the
StartSchemaCreationRequest.Builder
avoiding the need to create one manually viaStartSchemaCreationRequest.builder()
- Parameters:
startSchemaCreationRequest
- AConsumer
that will call methods onStartSchemaCreationRequest.Builder
to create a request.- Returns:
- Result of the StartSchemaCreation operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startSchemaMerge
default StartSchemaMergeResponse startSchemaMerge(StartSchemaMergeRequest startSchemaMergeRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppSyncException
Initiates a merge operation. Returns a status that shows the result of the merge operation.
- Parameters:
startSchemaMergeRequest
-- Returns:
- Result of the StartSchemaMerge operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startSchemaMerge
default StartSchemaMergeResponse startSchemaMerge(Consumer<StartSchemaMergeRequest.Builder> startSchemaMergeRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppSyncException
Initiates a merge operation. Returns a status that shows the result of the merge operation.
This is a convenience which creates an instance of the
StartSchemaMergeRequest.Builder
avoiding the need to create one manually viaStartSchemaMergeRequest.builder()
- Parameters:
startSchemaMergeRequest
- AConsumer
that will call methods onStartSchemaMergeRequest.Builder
to create a request.- Returns:
- Result of the StartSchemaMerge operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, NotFoundException, LimitExceededException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Tags a resource with user-supplied tags.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws BadRequestException, NotFoundException, LimitExceededException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Tags a resource with user-supplied tags.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException, NotFoundException, LimitExceededException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Untags a resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws BadRequestException, NotFoundException, LimitExceededException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Untags a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.LimitExceededException
- The request exceeded a limit. Try your request again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateApi
default UpdateApiResponse updateApi(UpdateApiRequest updateApiRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Updates an
Api
.- Parameters:
updateApiRequest
-- Returns:
- Result of the UpdateApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateApi
default UpdateApiResponse updateApi(Consumer<UpdateApiRequest.Builder> updateApiRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Updates an
Api
.
This is a convenience which creates an instance of the
UpdateApiRequest.Builder
avoiding the need to create one manually viaUpdateApiRequest.builder()
- Parameters:
updateApiRequest
- AConsumer
that will call methods onUpdateApiRequest.Builder
to create a request.- Returns:
- Result of the UpdateApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateApiCache
default UpdateApiCacheResponse updateApiCache(UpdateApiCacheRequest updateApiCacheRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Updates the cache for the GraphQL API.
- Parameters:
updateApiCacheRequest
- Represents the input of aUpdateApiCache
operation.- Returns:
- Result of the UpdateApiCache operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateApiCache
default UpdateApiCacheResponse updateApiCache(Consumer<UpdateApiCacheRequest.Builder> updateApiCacheRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Updates the cache for the GraphQL API.
This is a convenience which creates an instance of the
UpdateApiCacheRequest.Builder
avoiding the need to create one manually viaUpdateApiCacheRequest.builder()
- Parameters:
updateApiCacheRequest
- AConsumer
that will call methods onUpdateApiCacheRequest.Builder
to create a request. Represents the input of aUpdateApiCache
operation.- Returns:
- Result of the UpdateApiCache operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateApiKey
default UpdateApiKeyResponse updateApiKey(UpdateApiKeyRequest updateApiKeyRequest) throws BadRequestException, NotFoundException, UnauthorizedException, LimitExceededException, InternalFailureException, ApiKeyValidityOutOfBoundsException, AwsServiceException, SdkClientException, AppSyncException
Updates an API key. You can update the key as long as it's not deleted.
- Parameters:
updateApiKeyRequest
-- Returns:
- Result of the UpdateApiKey operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.LimitExceededException
- The request exceeded a limit. Try your request again.InternalFailureException
- An internal AppSync error occurred. Try your request again.ApiKeyValidityOutOfBoundsException
- The API key expiration must be set to a value between 1 and 365 days from creation (forCreateApiKey
) or from update (forUpdateApiKey
).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateApiKey
default UpdateApiKeyResponse updateApiKey(Consumer<UpdateApiKeyRequest.Builder> updateApiKeyRequest) throws BadRequestException, NotFoundException, UnauthorizedException, LimitExceededException, InternalFailureException, ApiKeyValidityOutOfBoundsException, AwsServiceException, SdkClientException, AppSyncException
Updates an API key. You can update the key as long as it's not deleted.
This is a convenience which creates an instance of the
UpdateApiKeyRequest.Builder
avoiding the need to create one manually viaUpdateApiKeyRequest.builder()
- Parameters:
updateApiKeyRequest
- AConsumer
that will call methods onUpdateApiKeyRequest.Builder
to create a request.- Returns:
- Result of the UpdateApiKey operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.LimitExceededException
- The request exceeded a limit. Try your request again.InternalFailureException
- An internal AppSync error occurred. Try your request again.ApiKeyValidityOutOfBoundsException
- The API key expiration must be set to a value between 1 and 365 days from creation (forCreateApiKey
) or from update (forUpdateApiKey
).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateChannelNamespace
default UpdateChannelNamespaceResponse updateChannelNamespace(UpdateChannelNamespaceRequest updateChannelNamespaceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Updates a
ChannelNamespace
associated with anApi
.- Parameters:
updateChannelNamespaceRequest
-- Returns:
- Result of the UpdateChannelNamespace operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateChannelNamespace
default UpdateChannelNamespaceResponse updateChannelNamespace(Consumer<UpdateChannelNamespaceRequest.Builder> updateChannelNamespaceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Updates a
ChannelNamespace
associated with anApi
.
This is a convenience which creates an instance of the
UpdateChannelNamespaceRequest.Builder
avoiding the need to create one manually viaUpdateChannelNamespaceRequest.builder()
- Parameters:
updateChannelNamespaceRequest
- AConsumer
that will call methods onUpdateChannelNamespaceRequest.Builder
to create a request.- Returns:
- Result of the UpdateChannelNamespace operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Updates a
DataSource
object.- Parameters:
updateDataSourceRequest
-- Returns:
- Result of the UpdateDataSource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Updates a
DataSource
object.
This is a convenience which creates an instance of the
UpdateDataSourceRequest.Builder
avoiding the need to create one manually viaUpdateDataSourceRequest.builder()
- Parameters:
updateDataSourceRequest
- AConsumer
that will call methods onUpdateDataSourceRequest.Builder
to create a request.- Returns:
- Result of the UpdateDataSource operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateDomainName
default UpdateDomainNameResponse updateDomainName(UpdateDomainNameRequest updateDomainNameRequest) throws AccessDeniedException, BadRequestException, ConcurrentModificationException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Updates a custom
DomainName
object.- Parameters:
updateDomainNameRequest
-- Returns:
- Result of the UpdateDomainName operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateDomainName
default UpdateDomainNameResponse updateDomainName(Consumer<UpdateDomainNameRequest.Builder> updateDomainNameRequest) throws AccessDeniedException, BadRequestException, ConcurrentModificationException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, AppSyncException
Updates a custom
DomainName
object.
This is a convenience which creates an instance of the
UpdateDomainNameRequest.Builder
avoiding the need to create one manually viaUpdateDomainNameRequest.builder()
- Parameters:
updateDomainNameRequest
- AConsumer
that will call methods onUpdateDomainNameRequest.Builder
to create a request.- Returns:
- Result of the UpdateDomainName operation returned by the service.
- Throws:
AccessDeniedException
- You don't have access to perform this operation on this resource.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateFunction
default UpdateFunctionResponse updateFunction(UpdateFunctionRequest updateFunctionRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Updates a
Function
object.- Parameters:
updateFunctionRequest
-- Returns:
- Result of the UpdateFunction operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateFunction
default UpdateFunctionResponse updateFunction(Consumer<UpdateFunctionRequest.Builder> updateFunctionRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Updates a
Function
object.
This is a convenience which creates an instance of the
UpdateFunctionRequest.Builder
avoiding the need to create one manually viaUpdateFunctionRequest.builder()
- Parameters:
updateFunctionRequest
- AConsumer
that will call methods onUpdateFunctionRequest.Builder
to create a request.- Returns:
- Result of the UpdateFunction operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateGraphqlApi
default UpdateGraphqlApiResponse updateGraphqlApi(UpdateGraphqlApiRequest updateGraphqlApiRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Updates a
GraphqlApi
object.- Parameters:
updateGraphqlApiRequest
-- Returns:
- Result of the UpdateGraphqlApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateGraphqlApi
default UpdateGraphqlApiResponse updateGraphqlApi(Consumer<UpdateGraphqlApiRequest.Builder> updateGraphqlApiRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AccessDeniedException, AwsServiceException, SdkClientException, AppSyncException
Updates a
GraphqlApi
object.
This is a convenience which creates an instance of the
UpdateGraphqlApiRequest.Builder
avoiding the need to create one manually viaUpdateGraphqlApiRequest.builder()
- Parameters:
updateGraphqlApiRequest
- AConsumer
that will call methods onUpdateGraphqlApiRequest.Builder
to create a request.- Returns:
- Result of the UpdateGraphqlApi operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.AccessDeniedException
- You don't have access to perform this operation on this resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateResolver
default UpdateResolverResponse updateResolver(UpdateResolverRequest updateResolverRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Updates a
Resolver
object.- Parameters:
updateResolverRequest
-- Returns:
- Result of the UpdateResolver operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateResolver
default UpdateResolverResponse updateResolver(Consumer<UpdateResolverRequest.Builder> updateResolverRequest) throws ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, AppSyncException
Updates a
Resolver
object.
This is a convenience which creates an instance of the
UpdateResolverRequest.Builder
avoiding the need to create one manually viaUpdateResolverRequest.builder()
- Parameters:
updateResolverRequest
- AConsumer
that will call methods onUpdateResolverRequest.Builder
to create a request.- Returns:
- Result of the UpdateResolver operation returned by the service.
- Throws:
ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateSourceApiAssociation
default UpdateSourceApiAssociationResponse updateSourceApiAssociation(UpdateSourceApiAssociationRequest updateSourceApiAssociationRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppSyncException
Updates some of the configuration choices of a particular source API association.
- Parameters:
updateSourceApiAssociationRequest
-- Returns:
- Result of the UpdateSourceApiAssociation operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateSourceApiAssociation
default UpdateSourceApiAssociationResponse updateSourceApiAssociation(Consumer<UpdateSourceApiAssociationRequest.Builder> updateSourceApiAssociationRequest) throws UnauthorizedException, BadRequestException, InternalFailureException, NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppSyncException
Updates some of the configuration choices of a particular source API association.
This is a convenience which creates an instance of the
UpdateSourceApiAssociationRequest.Builder
avoiding the need to create one manually viaUpdateSourceApiAssociationRequest.builder()
- Parameters:
updateSourceApiAssociationRequest
- AConsumer
that will call methods onUpdateSourceApiAssociationRequest.Builder
to create a request.- Returns:
- Result of the UpdateSourceApiAssociation operation returned by the service.
- Throws:
UnauthorizedException
- You aren't authorized to perform this operation.BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.InternalFailureException
- An internal AppSync error occurred. Try your request again.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateType
default UpdateTypeResponse updateType(UpdateTypeRequest updateTypeRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Updates a
Type
object.- Parameters:
updateTypeRequest
-- Returns:
- Result of the UpdateType operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateType
default UpdateTypeResponse updateType(Consumer<UpdateTypeRequest.Builder> updateTypeRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AppSyncException
Updates a
Type
object.
This is a convenience which creates an instance of the
UpdateTypeRequest.Builder
avoiding the need to create one manually viaUpdateTypeRequest.builder()
- Parameters:
updateTypeRequest
- AConsumer
that will call methods onUpdateTypeRequest.Builder
to create a request.- Returns:
- Result of the UpdateType operation returned by the service.
- Throws:
BadRequestException
- The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.ConcurrentModificationException
- Another modification is in progress at this time and it must complete before you can make your change.NotFoundException
- The resource specified in the request was not found. Check the resource, and then try again.UnauthorizedException
- You aren't authorized to perform this operation.InternalFailureException
- An internal AppSync error occurred. Try your request again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppSyncException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
create
static AppSyncClient create()
Create aAppSyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.
-
builder
static AppSyncClientBuilder builder()
Create a builder that can be used to configure and create aAppSyncClient
.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default AppSyncServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
-
-