software.amazon.awssdk.services.agcod

Interface AgcodClient

All Superinterfaces:

AutoCloseable, software.amazon.awssdk.utils.SdkAutoCloseable, software.amazon.awssdk.core.SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface AgcodClient
extends software.amazon.awssdk.core.SdkClient

Service client for accessing agcod. This can be created using the static builder() method. null

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static AgcodClientBuilder	builder() Create a builder that can be used to configure and create a AgcodClient.
default CancelGiftCardResponse	cancelGiftCard(CancelGiftCardRequest cancelGiftCardRequest) The CancelGiftCardRequest request cancels the Gift Card.
default CancelGiftCardResponse	cancelGiftCard(Consumer<CancelGiftCardRequest.Builder> cancelGiftCardRequest) The CancelGiftCardRequest request cancels the Gift Card.
static AgcodClient	create() Create a AgcodClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateGiftCardResponse	createGiftCard(Consumer<CreateGiftCardRequest.Builder> createGiftCardRequest) The CreateGiftCardRequest requests creates a Amazon Gift Card
default CreateGiftCardResponse	createGiftCard(CreateGiftCardRequest createGiftCardRequest) The CreateGiftCardRequest requests creates a Amazon Gift Card
default GetAvailableFundsResponse	getAvailableFunds(Consumer<GetAvailableFundsRequest.Builder> getAvailableFundsRequest) The GetAvailableFundsRequest returns the amount of funds currently available in your Amazon Incentives account.
default GetAvailableFundsResponse	getAvailableFunds(GetAvailableFundsRequest getAvailableFundsRequest) The GetAvailableFundsRequest returns the amount of funds currently available in your Amazon Incentives account.
static software.amazon.awssdk.regions.ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static AgcodClient create()

Create a AgcodClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static AgcodClientBuilder builder()

Create a builder that can be used to configure and create a AgcodClient.

cancelGiftCard

default CancelGiftCardResponse cancelGiftCard(CancelGiftCardRequest cancelGiftCardRequest)
                                       throws InternalServerErrorException,
                                              SystemErrorException,
                                              PartnerInputErrorException,
                                              PartnerAccessErrorException,
                                              ResendErrorException,
                                              UnknownErrorException,
                                              software.amazon.awssdk.awscore.exception.AwsServiceException,
                                              software.amazon.awssdk.core.exception.SdkClientException,
                                              AgcodException

The CancelGiftCardRequest request cancels the Gift Card. This operation can only be executed within 15 minutes of the creation request time stamp

Parameters:

cancelGiftCardRequest - Represents the input of a CancelGiftCardRequest operation.

Returns:

Result of the CancelGiftCard operation returned by the service.

Throws:

InternalServerErrorException - An error occurred on the server side.

SystemErrorException - F100: System Errors

PartnerInputErrorException - F200: Partner Input Errors

PartnerAccessErrorException - F300: Partner Account/Access/Onboarding Errors

ResendErrorException - F400: RESEND Errors

UnknownErrorException - F500: Unknown Errors

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

software.amazon.awssdk.core.exception.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

AgcodException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

software.amazon.awssdk.awscore.exception.AwsServiceException

See Also:

AWS API Documentation

cancelGiftCard

default CancelGiftCardResponse cancelGiftCard(Consumer<CancelGiftCardRequest.Builder> cancelGiftCardRequest)
                                       throws InternalServerErrorException,
                                              SystemErrorException,
                                              PartnerInputErrorException,
                                              PartnerAccessErrorException,
                                              ResendErrorException,
                                              UnknownErrorException,
                                              software.amazon.awssdk.awscore.exception.AwsServiceException,
                                              software.amazon.awssdk.core.exception.SdkClientException,
                                              AgcodException

The CancelGiftCardRequest request cancels the Gift Card. This operation can only be executed within 15 minutes of the creation request time stamp

This is a convenience which creates an instance of the CancelGiftCardRequest.Builder avoiding the need to create one manually via CancelGiftCardRequest.builder()

Parameters:

cancelGiftCardRequest - A Consumer that will call methods on CancelGiftCardInput.Builder to create a request. Represents the input of a CancelGiftCardRequest operation.

Returns:

Result of the CancelGiftCard operation returned by the service.

Throws:

InternalServerErrorException - An error occurred on the server side.

SystemErrorException - F100: System Errors

PartnerInputErrorException - F200: Partner Input Errors

PartnerAccessErrorException - F300: Partner Account/Access/Onboarding Errors

ResendErrorException - F400: RESEND Errors

UnknownErrorException - F500: Unknown Errors

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

software.amazon.awssdk.core.exception.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

AgcodException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

software.amazon.awssdk.awscore.exception.AwsServiceException

See Also:

AWS API Documentation

createGiftCard

default CreateGiftCardResponse createGiftCard(CreateGiftCardRequest createGiftCardRequest)
                                       throws InternalServerErrorException,
                                              SystemErrorException,
                                              PartnerInputErrorException,
                                              PartnerAccessErrorException,
                                              ResendErrorException,
                                              UnknownErrorException,
                                              software.amazon.awssdk.awscore.exception.AwsServiceException,
                                              software.amazon.awssdk.core.exception.SdkClientException,
                                              AgcodException

The CreateGiftCardRequest requests creates a Amazon Gift Card

Parameters:

createGiftCardRequest - Represents the input of a CreateGiftCardRequest operation.

Returns:

Result of the CreateGiftCard operation returned by the service.

Throws:

InternalServerErrorException - An error occurred on the server side.

SystemErrorException - F100: System Errors

PartnerInputErrorException - F200: Partner Input Errors

PartnerAccessErrorException - F300: Partner Account/Access/Onboarding Errors

ResendErrorException - F400: RESEND Errors

UnknownErrorException - F500: Unknown Errors

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

software.amazon.awssdk.core.exception.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

AgcodException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

software.amazon.awssdk.awscore.exception.AwsServiceException

See Also:

AWS API Documentation

createGiftCard

default CreateGiftCardResponse createGiftCard(Consumer<CreateGiftCardRequest.Builder> createGiftCardRequest)
                                       throws InternalServerErrorException,
                                              SystemErrorException,
                                              PartnerInputErrorException,
                                              PartnerAccessErrorException,
                                              ResendErrorException,
                                              UnknownErrorException,
                                              software.amazon.awssdk.awscore.exception.AwsServiceException,
                                              software.amazon.awssdk.core.exception.SdkClientException,
                                              AgcodException

The CreateGiftCardRequest requests creates a Amazon Gift Card

This is a convenience which creates an instance of the CreateGiftCardRequest.Builder avoiding the need to create one manually via CreateGiftCardRequest.builder()

Parameters:

createGiftCardRequest - A Consumer that will call methods on CreateGiftCardInput.Builder to create a request. Represents the input of a CreateGiftCardRequest operation.

Returns:

Result of the CreateGiftCard operation returned by the service.

Throws:

InternalServerErrorException - An error occurred on the server side.

SystemErrorException - F100: System Errors

PartnerInputErrorException - F200: Partner Input Errors

PartnerAccessErrorException - F300: Partner Account/Access/Onboarding Errors

ResendErrorException - F400: RESEND Errors

UnknownErrorException - F500: Unknown Errors

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

software.amazon.awssdk.core.exception.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

AgcodException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

software.amazon.awssdk.awscore.exception.AwsServiceException

See Also:

AWS API Documentation

getAvailableFunds

default GetAvailableFundsResponse getAvailableFunds(GetAvailableFundsRequest getAvailableFundsRequest)
                                             throws InternalServerErrorException,
                                                    SystemErrorException,
                                                    PartnerInputErrorException,
                                                    PartnerAccessErrorException,
                                                    ResendErrorException,
                                                    UnknownErrorException,
                                                    software.amazon.awssdk.awscore.exception.AwsServiceException,
                                                    software.amazon.awssdk.core.exception.SdkClientException,
                                                    AgcodException

The GetAvailableFundsRequest returns the amount of funds currently available in your Amazon Incentives account. It provides an alternative to logging into our portal for viewing available funds. A potential use-case of this operation is to develop a customized alerting system or checking the balance of an account periodically.

Parameters:

getAvailableFundsRequest - Represents the input of a GetAvailableFundsRequest operation.

Returns:

Result of the GetAvailableFunds operation returned by the service.

Throws:

InternalServerErrorException - An error occurred on the server side.

SystemErrorException - F100: System Errors

PartnerInputErrorException - F200: Partner Input Errors

PartnerAccessErrorException - F300: Partner Account/Access/Onboarding Errors

ResendErrorException - F400: RESEND Errors

UnknownErrorException - F500: Unknown Errors

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

software.amazon.awssdk.core.exception.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

AgcodException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

software.amazon.awssdk.awscore.exception.AwsServiceException

See Also:

AWS API Documentation

getAvailableFunds

default GetAvailableFundsResponse getAvailableFunds(Consumer<GetAvailableFundsRequest.Builder> getAvailableFundsRequest)
                                             throws InternalServerErrorException,
                                                    SystemErrorException,
                                                    PartnerInputErrorException,
                                                    PartnerAccessErrorException,
                                                    ResendErrorException,
                                                    UnknownErrorException,
                                                    software.amazon.awssdk.awscore.exception.AwsServiceException,
                                                    software.amazon.awssdk.core.exception.SdkClientException,
                                                    AgcodException

The GetAvailableFundsRequest returns the amount of funds currently available in your Amazon Incentives account. It provides an alternative to logging into our portal for viewing available funds. A potential use-case of this operation is to develop a customized alerting system or checking the balance of an account periodically.

This is a convenience which creates an instance of the GetAvailableFundsRequest.Builder avoiding the need to create one manually via GetAvailableFundsRequest.builder()

Parameters:

getAvailableFundsRequest - A Consumer that will call methods on GetAvailableFundsInput.Builder to create a request. Represents the input of a GetAvailableFundsRequest operation.

Returns:

Result of the GetAvailableFunds operation returned by the service.

Throws:

InternalServerErrorException - An error occurred on the server side.

SystemErrorException - F100: System Errors

PartnerInputErrorException - F200: Partner Input Errors

PartnerAccessErrorException - F300: Partner Account/Access/Onboarding Errors

ResendErrorException - F400: RESEND Errors

UnknownErrorException - F500: Unknown Errors

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

software.amazon.awssdk.core.exception.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

AgcodException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

software.amazon.awssdk.awscore.exception.AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static software.amazon.awssdk.regions.ServiceMetadata serviceMetadata()