ElastiCacheService overview
Added in v1.0.0
Table of contents
constructors
makeElastiCacheService
Signature
export declare const makeElastiCacheService: Effect.Effect<any, unknown, unknown>
Added in v1.0.0
models
ElastiCacheService (class)
Signature
export declare class ElastiCacheService
Added in v1.0.0
ElastiCacheService$ (interface)
Signature
export interface ElastiCacheService$ {
/**
* @see {@link AddTagsToResourceCommand}
*/
addTagsToResource(
args: AddTagsToResourceCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
AddTagsToResourceCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterNotFoundFaultError
| CacheParameterGroupNotFoundFaultError
| CacheSecurityGroupNotFoundFaultError
| CacheSubnetGroupNotFoundFaultError
| GlobalReplicationGroupNotFoundFaultError
| InvalidARNFaultError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| InvalidServerlessCacheSnapshotStateFaultError
| InvalidServerlessCacheStateFaultError
| ReplicationGroupNotFoundFaultError
| ReservedCacheNodeNotFoundFaultError
| ServerlessCacheNotFoundFaultError
| ServerlessCacheSnapshotNotFoundFaultError
| SnapshotNotFoundFaultError
| TagQuotaPerResourceExceededError
| UserGroupNotFoundFaultError
| UserNotFoundFaultError
>
/**
* @see {@link AuthorizeCacheSecurityGroupIngressCommand}
*/
authorizeCacheSecurityGroupIngress(
args: AuthorizeCacheSecurityGroupIngressCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
AuthorizeCacheSecurityGroupIngressCommandOutput,
| Cause.TimeoutError
| SdkError
| AuthorizationAlreadyExistsFaultError
| CacheSecurityGroupNotFoundFaultError
| InvalidCacheSecurityGroupStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link BatchApplyUpdateActionCommand}
*/
batchApplyUpdateAction(
args: BatchApplyUpdateActionCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
BatchApplyUpdateActionCommandOutput,
Cause.TimeoutError | SdkError | InvalidParameterValueError | ServiceUpdateNotFoundFaultError
>
/**
* @see {@link BatchStopUpdateActionCommand}
*/
batchStopUpdateAction(
args: BatchStopUpdateActionCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
BatchStopUpdateActionCommandOutput,
Cause.TimeoutError | SdkError | InvalidParameterValueError | ServiceUpdateNotFoundFaultError
>
/**
* @see {@link CompleteMigrationCommand}
*/
completeMigration(
args: CompleteMigrationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CompleteMigrationCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidReplicationGroupStateFaultError
| ReplicationGroupNotFoundFaultError
| ReplicationGroupNotUnderMigrationFaultError
>
/**
* @see {@link CopyServerlessCacheSnapshotCommand}
*/
copyServerlessCacheSnapshot(
args: CopyServerlessCacheSnapshotCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CopyServerlessCacheSnapshotCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidServerlessCacheSnapshotStateFaultError
| ServerlessCacheSnapshotAlreadyExistsFaultError
| ServerlessCacheSnapshotNotFoundFaultError
| ServerlessCacheSnapshotQuotaExceededFaultError
| ServiceLinkedRoleNotFoundFaultError
| TagQuotaPerResourceExceededError
>
/**
* @see {@link CopySnapshotCommand}
*/
copySnapshot(
args: CopySnapshotCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CopySnapshotCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidSnapshotStateFaultError
| SnapshotAlreadyExistsFaultError
| SnapshotNotFoundFaultError
| SnapshotQuotaExceededFaultError
| TagQuotaPerResourceExceededError
>
/**
* @see {@link CreateCacheClusterCommand}
*/
createCacheCluster(
args: CreateCacheClusterCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateCacheClusterCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterAlreadyExistsFaultError
| CacheParameterGroupNotFoundFaultError
| CacheSecurityGroupNotFoundFaultError
| CacheSubnetGroupNotFoundFaultError
| ClusterQuotaForCustomerExceededFaultError
| InsufficientCacheClusterCapacityFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| InvalidVPCNetworkStateFaultError
| NodeQuotaForClusterExceededFaultError
| NodeQuotaForCustomerExceededFaultError
| ReplicationGroupNotFoundFaultError
| TagQuotaPerResourceExceededError
>
/**
* @see {@link CreateCacheParameterGroupCommand}
*/
createCacheParameterGroup(
args: CreateCacheParameterGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateCacheParameterGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheParameterGroupAlreadyExistsFaultError
| CacheParameterGroupQuotaExceededFaultError
| InvalidCacheParameterGroupStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| TagQuotaPerResourceExceededError
>
/**
* @see {@link CreateCacheSecurityGroupCommand}
*/
createCacheSecurityGroup(
args: CreateCacheSecurityGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateCacheSecurityGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheSecurityGroupAlreadyExistsFaultError
| CacheSecurityGroupQuotaExceededFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| TagQuotaPerResourceExceededError
>
/**
* @see {@link CreateCacheSubnetGroupCommand}
*/
createCacheSubnetGroup(
args: CreateCacheSubnetGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateCacheSubnetGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheSubnetGroupAlreadyExistsFaultError
| CacheSubnetGroupQuotaExceededFaultError
| CacheSubnetQuotaExceededFaultError
| InvalidSubnetError
| SubnetNotAllowedFaultError
| TagQuotaPerResourceExceededError
>
/**
* @see {@link CreateGlobalReplicationGroupCommand}
*/
createGlobalReplicationGroup(
args: CreateGlobalReplicationGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateGlobalReplicationGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| GlobalReplicationGroupAlreadyExistsFaultError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| ReplicationGroupNotFoundFaultError
| ServiceLinkedRoleNotFoundFaultError
| TagQuotaPerResourceExceededError
>
/**
* @see {@link CreateReplicationGroupCommand}
*/
createReplicationGroup(
args: CreateReplicationGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateReplicationGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterNotFoundFaultError
| CacheParameterGroupNotFoundFaultError
| CacheSecurityGroupNotFoundFaultError
| CacheSubnetGroupNotFoundFaultError
| ClusterQuotaForCustomerExceededFaultError
| GlobalReplicationGroupNotFoundFaultError
| InsufficientCacheClusterCapacityFaultError
| InvalidCacheClusterStateFaultError
| InvalidGlobalReplicationGroupStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidUserGroupStateFaultError
| InvalidVPCNetworkStateFaultError
| NodeGroupsPerReplicationGroupQuotaExceededFaultError
| NodeQuotaForClusterExceededFaultError
| NodeQuotaForCustomerExceededFaultError
| ReplicationGroupAlreadyExistsFaultError
| TagQuotaPerResourceExceededError
| UserGroupNotFoundFaultError
>
/**
* @see {@link CreateServerlessCacheCommand}
*/
createServerlessCache(
args: CreateServerlessCacheCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateServerlessCacheCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidCredentialsError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidServerlessCacheStateFaultError
| InvalidUserGroupStateFaultError
| ServerlessCacheAlreadyExistsFaultError
| ServerlessCacheNotFoundFaultError
| ServerlessCacheQuotaForCustomerExceededFaultError
| ServiceLinkedRoleNotFoundFaultError
| TagQuotaPerResourceExceededError
| UserGroupNotFoundFaultError
>
/**
* @see {@link CreateServerlessCacheSnapshotCommand}
*/
createServerlessCacheSnapshot(
args: CreateServerlessCacheSnapshotCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateServerlessCacheSnapshotCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidServerlessCacheStateFaultError
| ServerlessCacheNotFoundFaultError
| ServerlessCacheSnapshotAlreadyExistsFaultError
| ServerlessCacheSnapshotQuotaExceededFaultError
| ServiceLinkedRoleNotFoundFaultError
| TagQuotaPerResourceExceededError
>
/**
* @see {@link CreateSnapshotCommand}
*/
createSnapshot(
args: CreateSnapshotCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateSnapshotCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterNotFoundFaultError
| InvalidCacheClusterStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| ReplicationGroupNotFoundFaultError
| SnapshotAlreadyExistsFaultError
| SnapshotFeatureNotSupportedFaultError
| SnapshotQuotaExceededFaultError
| TagQuotaPerResourceExceededError
>
/**
* @see {@link CreateUserCommand}
*/
createUser(
args: CreateUserCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateUserCommandOutput,
| Cause.TimeoutError
| SdkError
| DuplicateUserNameFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ServiceLinkedRoleNotFoundFaultError
| TagQuotaPerResourceExceededError
| UserAlreadyExistsFaultError
| UserQuotaExceededFaultError
>
/**
* @see {@link CreateUserGroupCommand}
*/
createUserGroup(
args: CreateUserGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateUserGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| DefaultUserRequiredError
| DuplicateUserNameFaultError
| InvalidParameterValueError
| ServiceLinkedRoleNotFoundFaultError
| TagQuotaPerResourceExceededError
| UserGroupAlreadyExistsFaultError
| UserGroupQuotaExceededFaultError
| UserNotFoundFaultError
>
/**
* @see {@link DecreaseNodeGroupsInGlobalReplicationGroupCommand}
*/
decreaseNodeGroupsInGlobalReplicationGroup(
args: DecreaseNodeGroupsInGlobalReplicationGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DecreaseNodeGroupsInGlobalReplicationGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| GlobalReplicationGroupNotFoundFaultError
| InvalidGlobalReplicationGroupStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link DecreaseReplicaCountCommand}
*/
decreaseReplicaCount(
args: DecreaseReplicaCountCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DecreaseReplicaCountCommandOutput,
| Cause.TimeoutError
| SdkError
| ClusterQuotaForCustomerExceededFaultError
| InsufficientCacheClusterCapacityFaultError
| InvalidCacheClusterStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| InvalidVPCNetworkStateFaultError
| NodeGroupsPerReplicationGroupQuotaExceededFaultError
| NodeQuotaForCustomerExceededFaultError
| NoOperationFaultError
| ReplicationGroupNotFoundFaultError
| ServiceLinkedRoleNotFoundFaultError
>
/**
* @see {@link DeleteCacheClusterCommand}
*/
deleteCacheCluster(
args: DeleteCacheClusterCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteCacheClusterCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterNotFoundFaultError
| InvalidCacheClusterStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| SnapshotAlreadyExistsFaultError
| SnapshotFeatureNotSupportedFaultError
| SnapshotQuotaExceededFaultError
>
/**
* @see {@link DeleteCacheParameterGroupCommand}
*/
deleteCacheParameterGroup(
args: DeleteCacheParameterGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteCacheParameterGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheParameterGroupNotFoundFaultError
| InvalidCacheParameterGroupStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link DeleteCacheSecurityGroupCommand}
*/
deleteCacheSecurityGroup(
args: DeleteCacheSecurityGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteCacheSecurityGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheSecurityGroupNotFoundFaultError
| InvalidCacheSecurityGroupStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link DeleteCacheSubnetGroupCommand}
*/
deleteCacheSubnetGroup(
args: DeleteCacheSubnetGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteCacheSubnetGroupCommandOutput,
Cause.TimeoutError | SdkError | CacheSubnetGroupInUseError | CacheSubnetGroupNotFoundFaultError
>
/**
* @see {@link DeleteGlobalReplicationGroupCommand}
*/
deleteGlobalReplicationGroup(
args: DeleteGlobalReplicationGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteGlobalReplicationGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| GlobalReplicationGroupNotFoundFaultError
| InvalidGlobalReplicationGroupStateFaultError
| InvalidParameterValueError
>
/**
* @see {@link DeleteReplicationGroupCommand}
*/
deleteReplicationGroup(
args: DeleteReplicationGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteReplicationGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| ReplicationGroupNotFoundFaultError
| SnapshotAlreadyExistsFaultError
| SnapshotFeatureNotSupportedFaultError
| SnapshotQuotaExceededFaultError
>
/**
* @see {@link DeleteServerlessCacheCommand}
*/
deleteServerlessCache(
args: DeleteServerlessCacheCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteServerlessCacheCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidCredentialsError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidServerlessCacheStateFaultError
| ServerlessCacheNotFoundFaultError
| ServerlessCacheSnapshotAlreadyExistsFaultError
| ServiceLinkedRoleNotFoundFaultError
>
/**
* @see {@link DeleteServerlessCacheSnapshotCommand}
*/
deleteServerlessCacheSnapshot(
args: DeleteServerlessCacheSnapshotCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteServerlessCacheSnapshotCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterValueError
| InvalidServerlessCacheSnapshotStateFaultError
| ServerlessCacheSnapshotNotFoundFaultError
| ServiceLinkedRoleNotFoundFaultError
>
/**
* @see {@link DeleteSnapshotCommand}
*/
deleteSnapshot(
args: DeleteSnapshotCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteSnapshotCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidSnapshotStateFaultError
| SnapshotNotFoundFaultError
>
/**
* @see {@link DeleteUserCommand}
*/
deleteUser(
args: DeleteUserCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteUserCommandOutput,
| Cause.TimeoutError
| SdkError
| DefaultUserAssociatedToUserGroupFaultError
| InvalidParameterValueError
| InvalidUserStateFaultError
| ServiceLinkedRoleNotFoundFaultError
| UserNotFoundFaultError
>
/**
* @see {@link DeleteUserGroupCommand}
*/
deleteUserGroup(
args: DeleteUserGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteUserGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterValueError
| InvalidUserGroupStateFaultError
| ServiceLinkedRoleNotFoundFaultError
| UserGroupNotFoundFaultError
>
/**
* @see {@link DescribeCacheClustersCommand}
*/
describeCacheClusters(
args: DescribeCacheClustersCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeCacheClustersCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterNotFoundFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
describeCacheClustersStream(
args: DescribeCacheClustersCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeCacheClustersCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterNotFoundFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link DescribeCacheEngineVersionsCommand}
*/
describeCacheEngineVersions(
args: DescribeCacheEngineVersionsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DescribeCacheEngineVersionsCommandOutput, Cause.TimeoutError | SdkError>
describeCacheEngineVersionsStream(
args: DescribeCacheEngineVersionsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<DescribeCacheEngineVersionsCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link DescribeCacheParameterGroupsCommand}
*/
describeCacheParameterGroups(
args: DescribeCacheParameterGroupsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeCacheParameterGroupsCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheParameterGroupNotFoundFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
describeCacheParameterGroupsStream(
args: DescribeCacheParameterGroupsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeCacheParameterGroupsCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheParameterGroupNotFoundFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link DescribeCacheParametersCommand}
*/
describeCacheParameters(
args: DescribeCacheParametersCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeCacheParametersCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheParameterGroupNotFoundFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
describeCacheParametersStream(
args: DescribeCacheParametersCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeCacheParametersCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheParameterGroupNotFoundFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link DescribeCacheSecurityGroupsCommand}
*/
describeCacheSecurityGroups(
args: DescribeCacheSecurityGroupsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeCacheSecurityGroupsCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheSecurityGroupNotFoundFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
describeCacheSecurityGroupsStream(
args: DescribeCacheSecurityGroupsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeCacheSecurityGroupsCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheSecurityGroupNotFoundFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link DescribeCacheSubnetGroupsCommand}
*/
describeCacheSubnetGroups(
args: DescribeCacheSubnetGroupsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeCacheSubnetGroupsCommandOutput,
Cause.TimeoutError | SdkError | CacheSubnetGroupNotFoundFaultError
>
describeCacheSubnetGroupsStream(
args: DescribeCacheSubnetGroupsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeCacheSubnetGroupsCommandOutput,
Cause.TimeoutError | SdkError | CacheSubnetGroupNotFoundFaultError
>
/**
* @see {@link DescribeEngineDefaultParametersCommand}
*/
describeEngineDefaultParameters(
args: DescribeEngineDefaultParametersCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeEngineDefaultParametersCommandOutput,
Cause.TimeoutError | SdkError | InvalidParameterCombinationError | InvalidParameterValueError
>
describeEngineDefaultParametersStream(
args: DescribeEngineDefaultParametersCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeEngineDefaultParametersCommandOutput,
Cause.TimeoutError | SdkError | InvalidParameterCombinationError | InvalidParameterValueError
>
/**
* @see {@link DescribeEventsCommand}
*/
describeEvents(
args: DescribeEventsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeEventsCommandOutput,
Cause.TimeoutError | SdkError | InvalidParameterCombinationError | InvalidParameterValueError
>
describeEventsStream(
args: DescribeEventsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeEventsCommandOutput,
Cause.TimeoutError | SdkError | InvalidParameterCombinationError | InvalidParameterValueError
>
/**
* @see {@link DescribeGlobalReplicationGroupsCommand}
*/
describeGlobalReplicationGroups(
args: DescribeGlobalReplicationGroupsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeGlobalReplicationGroupsCommandOutput,
| Cause.TimeoutError
| SdkError
| GlobalReplicationGroupNotFoundFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
describeGlobalReplicationGroupsStream(
args: DescribeGlobalReplicationGroupsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeGlobalReplicationGroupsCommandOutput,
| Cause.TimeoutError
| SdkError
| GlobalReplicationGroupNotFoundFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link DescribeReplicationGroupsCommand}
*/
describeReplicationGroups(
args: DescribeReplicationGroupsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeReplicationGroupsCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ReplicationGroupNotFoundFaultError
>
describeReplicationGroupsStream(
args: DescribeReplicationGroupsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeReplicationGroupsCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ReplicationGroupNotFoundFaultError
>
/**
* @see {@link DescribeReservedCacheNodesCommand}
*/
describeReservedCacheNodes(
args: DescribeReservedCacheNodesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeReservedCacheNodesCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ReservedCacheNodeNotFoundFaultError
>
describeReservedCacheNodesStream(
args: DescribeReservedCacheNodesCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeReservedCacheNodesCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ReservedCacheNodeNotFoundFaultError
>
/**
* @see {@link DescribeReservedCacheNodesOfferingsCommand}
*/
describeReservedCacheNodesOfferings(
args: DescribeReservedCacheNodesOfferingsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeReservedCacheNodesOfferingsCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ReservedCacheNodesOfferingNotFoundFaultError
>
describeReservedCacheNodesOfferingsStream(
args: DescribeReservedCacheNodesOfferingsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeReservedCacheNodesOfferingsCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ReservedCacheNodesOfferingNotFoundFaultError
>
/**
* @see {@link DescribeServerlessCacheSnapshotsCommand}
*/
describeServerlessCacheSnapshots(
args: DescribeServerlessCacheSnapshotsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeServerlessCacheSnapshotsCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ServerlessCacheNotFoundFaultError
| ServerlessCacheSnapshotNotFoundFaultError
>
describeServerlessCacheSnapshotsStream(
args: DescribeServerlessCacheSnapshotsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeServerlessCacheSnapshotsCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ServerlessCacheNotFoundFaultError
| ServerlessCacheSnapshotNotFoundFaultError
>
/**
* @see {@link DescribeServerlessCachesCommand}
*/
describeServerlessCaches(
args: DescribeServerlessCachesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeServerlessCachesCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ServerlessCacheNotFoundFaultError
>
describeServerlessCachesStream(
args: DescribeServerlessCachesCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeServerlessCachesCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ServerlessCacheNotFoundFaultError
>
/**
* @see {@link DescribeServiceUpdatesCommand}
*/
describeServiceUpdates(
args: DescribeServiceUpdatesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeServiceUpdatesCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ServiceUpdateNotFoundFaultError
>
describeServiceUpdatesStream(
args: DescribeServiceUpdatesCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeServiceUpdatesCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ServiceUpdateNotFoundFaultError
>
/**
* @see {@link DescribeSnapshotsCommand}
*/
describeSnapshots(
args: DescribeSnapshotsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeSnapshotsCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterNotFoundFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| SnapshotNotFoundFaultError
>
describeSnapshotsStream(
args: DescribeSnapshotsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeSnapshotsCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterNotFoundFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| SnapshotNotFoundFaultError
>
/**
* @see {@link DescribeUpdateActionsCommand}
*/
describeUpdateActions(
args: DescribeUpdateActionsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeUpdateActionsCommandOutput,
Cause.TimeoutError | SdkError | InvalidParameterCombinationError | InvalidParameterValueError
>
describeUpdateActionsStream(
args: DescribeUpdateActionsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeUpdateActionsCommandOutput,
Cause.TimeoutError | SdkError | InvalidParameterCombinationError | InvalidParameterValueError
>
/**
* @see {@link DescribeUserGroupsCommand}
*/
describeUserGroups(
args: DescribeUserGroupsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeUserGroupsCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| ServiceLinkedRoleNotFoundFaultError
| UserGroupNotFoundFaultError
>
describeUserGroupsStream(
args: DescribeUserGroupsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeUserGroupsCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| ServiceLinkedRoleNotFoundFaultError
| UserGroupNotFoundFaultError
>
/**
* @see {@link DescribeUsersCommand}
*/
describeUsers(
args: DescribeUsersCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeUsersCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| ServiceLinkedRoleNotFoundFaultError
| UserNotFoundFaultError
>
describeUsersStream(
args: DescribeUsersCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeUsersCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| ServiceLinkedRoleNotFoundFaultError
| UserNotFoundFaultError
>
/**
* @see {@link DisassociateGlobalReplicationGroupCommand}
*/
disassociateGlobalReplicationGroup(
args: DisassociateGlobalReplicationGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DisassociateGlobalReplicationGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| GlobalReplicationGroupNotFoundFaultError
| InvalidGlobalReplicationGroupStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link ExportServerlessCacheSnapshotCommand}
*/
exportServerlessCacheSnapshot(
args: ExportServerlessCacheSnapshotCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ExportServerlessCacheSnapshotCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterValueError
| InvalidServerlessCacheSnapshotStateFaultError
| ServerlessCacheSnapshotNotFoundFaultError
| ServiceLinkedRoleNotFoundFaultError
>
/**
* @see {@link FailoverGlobalReplicationGroupCommand}
*/
failoverGlobalReplicationGroup(
args: FailoverGlobalReplicationGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
FailoverGlobalReplicationGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| GlobalReplicationGroupNotFoundFaultError
| InvalidGlobalReplicationGroupStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link IncreaseNodeGroupsInGlobalReplicationGroupCommand}
*/
increaseNodeGroupsInGlobalReplicationGroup(
args: IncreaseNodeGroupsInGlobalReplicationGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
IncreaseNodeGroupsInGlobalReplicationGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| GlobalReplicationGroupNotFoundFaultError
| InvalidGlobalReplicationGroupStateFaultError
| InvalidParameterValueError
>
/**
* @see {@link IncreaseReplicaCountCommand}
*/
increaseReplicaCount(
args: IncreaseReplicaCountCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
IncreaseReplicaCountCommandOutput,
| Cause.TimeoutError
| SdkError
| ClusterQuotaForCustomerExceededFaultError
| InsufficientCacheClusterCapacityFaultError
| InvalidCacheClusterStateFaultError
| InvalidKMSKeyFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| InvalidVPCNetworkStateFaultError
| NodeGroupsPerReplicationGroupQuotaExceededFaultError
| NodeQuotaForCustomerExceededFaultError
| NoOperationFaultError
| ReplicationGroupNotFoundFaultError
>
/**
* @see {@link ListAllowedNodeTypeModificationsCommand}
*/
listAllowedNodeTypeModifications(
args: ListAllowedNodeTypeModificationsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListAllowedNodeTypeModificationsCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterNotFoundFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ReplicationGroupNotFoundFaultError
>
/**
* @see {@link ListTagsForResourceCommand}
*/
listTagsForResource(
args: ListTagsForResourceCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListTagsForResourceCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterNotFoundFaultError
| CacheParameterGroupNotFoundFaultError
| CacheSecurityGroupNotFoundFaultError
| CacheSubnetGroupNotFoundFaultError
| GlobalReplicationGroupNotFoundFaultError
| InvalidARNFaultError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| InvalidServerlessCacheSnapshotStateFaultError
| InvalidServerlessCacheStateFaultError
| ReplicationGroupNotFoundFaultError
| ReservedCacheNodeNotFoundFaultError
| ServerlessCacheNotFoundFaultError
| ServerlessCacheSnapshotNotFoundFaultError
| SnapshotNotFoundFaultError
| UserGroupNotFoundFaultError
| UserNotFoundFaultError
>
/**
* @see {@link ModifyCacheClusterCommand}
*/
modifyCacheCluster(
args: ModifyCacheClusterCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ModifyCacheClusterCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterNotFoundFaultError
| CacheParameterGroupNotFoundFaultError
| CacheSecurityGroupNotFoundFaultError
| InsufficientCacheClusterCapacityFaultError
| InvalidCacheClusterStateFaultError
| InvalidCacheSecurityGroupStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidVPCNetworkStateFaultError
| NodeQuotaForClusterExceededFaultError
| NodeQuotaForCustomerExceededFaultError
>
/**
* @see {@link ModifyCacheParameterGroupCommand}
*/
modifyCacheParameterGroup(
args: ModifyCacheParameterGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ModifyCacheParameterGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheParameterGroupNotFoundFaultError
| InvalidCacheParameterGroupStateFaultError
| InvalidGlobalReplicationGroupStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link ModifyCacheSubnetGroupCommand}
*/
modifyCacheSubnetGroup(
args: ModifyCacheSubnetGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ModifyCacheSubnetGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheSubnetGroupNotFoundFaultError
| CacheSubnetQuotaExceededFaultError
| InvalidSubnetError
| SubnetInUseError
| SubnetNotAllowedFaultError
>
/**
* @see {@link ModifyGlobalReplicationGroupCommand}
*/
modifyGlobalReplicationGroup(
args: ModifyGlobalReplicationGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ModifyGlobalReplicationGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| GlobalReplicationGroupNotFoundFaultError
| InvalidGlobalReplicationGroupStateFaultError
| InvalidParameterValueError
>
/**
* @see {@link ModifyReplicationGroupCommand}
*/
modifyReplicationGroup(
args: ModifyReplicationGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ModifyReplicationGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterNotFoundFaultError
| CacheParameterGroupNotFoundFaultError
| CacheSecurityGroupNotFoundFaultError
| InsufficientCacheClusterCapacityFaultError
| InvalidCacheClusterStateFaultError
| InvalidCacheSecurityGroupStateFaultError
| InvalidKMSKeyFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| InvalidUserGroupStateFaultError
| InvalidVPCNetworkStateFaultError
| NodeQuotaForClusterExceededFaultError
| NodeQuotaForCustomerExceededFaultError
| ReplicationGroupNotFoundFaultError
| UserGroupNotFoundFaultError
>
/**
* @see {@link ModifyReplicationGroupShardConfigurationCommand}
*/
modifyReplicationGroupShardConfiguration(
args: ModifyReplicationGroupShardConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ModifyReplicationGroupShardConfigurationCommandOutput,
| Cause.TimeoutError
| SdkError
| InsufficientCacheClusterCapacityFaultError
| InvalidCacheClusterStateFaultError
| InvalidKMSKeyFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| InvalidVPCNetworkStateFaultError
| NodeGroupsPerReplicationGroupQuotaExceededFaultError
| NodeQuotaForCustomerExceededFaultError
| ReplicationGroupNotFoundFaultError
>
/**
* @see {@link ModifyServerlessCacheCommand}
*/
modifyServerlessCache(
args: ModifyServerlessCacheCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ModifyServerlessCacheCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidCredentialsError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidServerlessCacheStateFaultError
| InvalidUserGroupStateFaultError
| ServerlessCacheNotFoundFaultError
| ServiceLinkedRoleNotFoundFaultError
| UserGroupNotFoundFaultError
>
/**
* @see {@link ModifyUserCommand}
*/
modifyUser(
args: ModifyUserCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ModifyUserCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidUserStateFaultError
| ServiceLinkedRoleNotFoundFaultError
| UserNotFoundFaultError
>
/**
* @see {@link ModifyUserGroupCommand}
*/
modifyUserGroup(
args: ModifyUserGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ModifyUserGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| DefaultUserRequiredError
| DuplicateUserNameFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidUserGroupStateFaultError
| ServiceLinkedRoleNotFoundFaultError
| UserGroupNotFoundFaultError
| UserNotFoundFaultError
>
/**
* @see {@link PurchaseReservedCacheNodesOfferingCommand}
*/
purchaseReservedCacheNodesOffering(
args: PurchaseReservedCacheNodesOfferingCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PurchaseReservedCacheNodesOfferingCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterCombinationError
| InvalidParameterValueError
| ReservedCacheNodeAlreadyExistsFaultError
| ReservedCacheNodeQuotaExceededFaultError
| ReservedCacheNodesOfferingNotFoundFaultError
| TagQuotaPerResourceExceededError
>
/**
* @see {@link RebalanceSlotsInGlobalReplicationGroupCommand}
*/
rebalanceSlotsInGlobalReplicationGroup(
args: RebalanceSlotsInGlobalReplicationGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
RebalanceSlotsInGlobalReplicationGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| GlobalReplicationGroupNotFoundFaultError
| InvalidGlobalReplicationGroupStateFaultError
| InvalidParameterValueError
>
/**
* @see {@link RebootCacheClusterCommand}
*/
rebootCacheCluster(
args: RebootCacheClusterCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
RebootCacheClusterCommandOutput,
Cause.TimeoutError | SdkError | CacheClusterNotFoundFaultError | InvalidCacheClusterStateFaultError
>
/**
* @see {@link RemoveTagsFromResourceCommand}
*/
removeTagsFromResource(
args: RemoveTagsFromResourceCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
RemoveTagsFromResourceCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheClusterNotFoundFaultError
| CacheParameterGroupNotFoundFaultError
| CacheSecurityGroupNotFoundFaultError
| CacheSubnetGroupNotFoundFaultError
| GlobalReplicationGroupNotFoundFaultError
| InvalidARNFaultError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| InvalidServerlessCacheSnapshotStateFaultError
| InvalidServerlessCacheStateFaultError
| ReplicationGroupNotFoundFaultError
| ReservedCacheNodeNotFoundFaultError
| ServerlessCacheNotFoundFaultError
| ServerlessCacheSnapshotNotFoundFaultError
| SnapshotNotFoundFaultError
| TagNotFoundFaultError
| UserGroupNotFoundFaultError
| UserNotFoundFaultError
>
/**
* @see {@link ResetCacheParameterGroupCommand}
*/
resetCacheParameterGroup(
args: ResetCacheParameterGroupCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ResetCacheParameterGroupCommandOutput,
| Cause.TimeoutError
| SdkError
| CacheParameterGroupNotFoundFaultError
| InvalidCacheParameterGroupStateFaultError
| InvalidGlobalReplicationGroupStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link RevokeCacheSecurityGroupIngressCommand}
*/
revokeCacheSecurityGroupIngress(
args: RevokeCacheSecurityGroupIngressCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
RevokeCacheSecurityGroupIngressCommandOutput,
| Cause.TimeoutError
| SdkError
| AuthorizationNotFoundFaultError
| CacheSecurityGroupNotFoundFaultError
| InvalidCacheSecurityGroupStateFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link StartMigrationCommand}
*/
startMigration(
args: StartMigrationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
StartMigrationCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| ReplicationGroupAlreadyUnderMigrationFaultError
| ReplicationGroupNotFoundFaultError
>
/**
* @see {@link TestFailoverCommand}
*/
testFailover(
args: TestFailoverCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
TestFailoverCommandOutput,
| Cause.TimeoutError
| SdkError
| APICallRateForCustomerExceededFaultError
| InvalidCacheClusterStateFaultError
| InvalidKMSKeyFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| NodeGroupNotFoundFaultError
| ReplicationGroupNotFoundFaultError
| TestFailoverNotAvailableFaultError
>
/**
* @see {@link TestMigrationCommand}
*/
testMigration(
args: TestMigrationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
TestMigrationCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterValueError
| InvalidReplicationGroupStateFaultError
| ReplicationGroupAlreadyUnderMigrationFaultError
| ReplicationGroupNotFoundFaultError
>
}
Added in v1.0.0
utils
ElastiCacheService (namespace)
Added in v1.0.0
Config (interface)
Signature
export interface Config extends Omit<ElastiCacheClientConfig, "logger"> {
readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}
Added in v1.0.0
Type (type alias)
Signature
export type Type = ElastiCacheService$
Added in v1.0.0