DynamoDBService overview
Added in v1.0.0
Table of contents
constructors
makeDynamoDBService
Signature
export declare const makeDynamoDBService: Effect.Effect<DynamoDBService, never, DynamoDBClientInstance>
Added in v1.0.0
layers
BaseDynamoDBServiceLayer
Signature
export declare const BaseDynamoDBServiceLayer: Layer.Layer<DynamoDBService, never, DynamoDBClientInstance>
Added in v1.0.0
DefaultDynamoDBServiceLayer
Signature
export declare const DefaultDynamoDBServiceLayer: Layer.Layer<DynamoDBService, never, never>
Added in v1.0.0
DynamoDBServiceLayer
Signature
export declare const DynamoDBServiceLayer: Layer.Layer<DynamoDBService, never, DynamoDBClientInstanceConfig>
Added in v1.0.0
models
DynamoDBService (interface)
Signature
export interface DynamoDBService {
readonly _: unique symbol
/**
* @see {@link BatchExecuteStatementCommand}
*/
batchExecuteStatement(
args: BatchExecuteStatementCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<BatchExecuteStatementCommandOutput, SdkError | InternalServerError | RequestLimitExceededError>
/**
* @see {@link BatchGetItemCommand}
*/
batchGetItem(
args: BatchGetItemCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
BatchGetItemCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| ProvisionedThroughputExceededError
| RequestLimitExceededError
| ResourceNotFoundError
>
/**
* @see {@link BatchWriteItemCommand}
*/
batchWriteItem(
args: BatchWriteItemCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
BatchWriteItemCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| ItemCollectionSizeLimitExceededError
| ProvisionedThroughputExceededError
| RequestLimitExceededError
| ResourceNotFoundError
>
/**
* @see {@link CreateBackupCommand}
*/
createBackup(
args: CreateBackupCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
CreateBackupCommandOutput,
| SdkError
| BackupInUseError
| ContinuousBackupsUnavailableError
| InternalServerError
| InvalidEndpointError
| LimitExceededError
| TableInUseError
| TableNotFoundError
>
/**
* @see {@link CreateGlobalTableCommand}
*/
createGlobalTable(
args: CreateGlobalTableCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
CreateGlobalTableCommandOutput,
| SdkError
| GlobalTableAlreadyExistsError
| InternalServerError
| InvalidEndpointError
| LimitExceededError
| TableNotFoundError
>
/**
* @see {@link CreateTableCommand}
*/
createTable(
args: CreateTableCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
CreateTableCommandOutput,
SdkError | InternalServerError | InvalidEndpointError | LimitExceededError | ResourceInUseError
>
/**
* @see {@link DeleteBackupCommand}
*/
deleteBackup(
args: DeleteBackupCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
DeleteBackupCommandOutput,
SdkError | BackupInUseError | BackupNotFoundError | InternalServerError | InvalidEndpointError | LimitExceededError
>
/**
* @see {@link DeleteItemCommand}
*/
deleteItem(
args: DeleteItemCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
DeleteItemCommandOutput,
| SdkError
| ConditionalCheckFailedError
| InternalServerError
| InvalidEndpointError
| ItemCollectionSizeLimitExceededError
| ProvisionedThroughputExceededError
| RequestLimitExceededError
| ResourceNotFoundError
| TransactionConflictError
>
/**
* @see {@link DeleteTableCommand}
*/
deleteTable(
args: DeleteTableCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
DeleteTableCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| LimitExceededError
| ResourceInUseError
| ResourceNotFoundError
>
/**
* @see {@link DescribeBackupCommand}
*/
describeBackup(
args: DescribeBackupCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
DescribeBackupCommandOutput,
SdkError | BackupNotFoundError | InternalServerError | InvalidEndpointError
>
/**
* @see {@link DescribeContinuousBackupsCommand}
*/
describeContinuousBackups(
args: DescribeContinuousBackupsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
DescribeContinuousBackupsCommandOutput,
SdkError | InternalServerError | InvalidEndpointError | TableNotFoundError
>
/**
* @see {@link DescribeContributorInsightsCommand}
*/
describeContributorInsights(
args: DescribeContributorInsightsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<DescribeContributorInsightsCommandOutput, SdkError | InternalServerError | ResourceNotFoundError>
/**
* @see {@link DescribeEndpointsCommand}
*/
describeEndpoints(
args: DescribeEndpointsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<DescribeEndpointsCommandOutput, SdkError>
/**
* @see {@link DescribeExportCommand}
*/
describeExport(
args: DescribeExportCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
DescribeExportCommandOutput,
SdkError | ExportNotFoundError | InternalServerError | LimitExceededError
>
/**
* @see {@link DescribeGlobalTableCommand}
*/
describeGlobalTable(
args: DescribeGlobalTableCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
DescribeGlobalTableCommandOutput,
SdkError | GlobalTableNotFoundError | InternalServerError | InvalidEndpointError
>
/**
* @see {@link DescribeGlobalTableSettingsCommand}
*/
describeGlobalTableSettings(
args: DescribeGlobalTableSettingsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
DescribeGlobalTableSettingsCommandOutput,
SdkError | GlobalTableNotFoundError | InternalServerError | InvalidEndpointError
>
/**
* @see {@link DescribeImportCommand}
*/
describeImport(
args: DescribeImportCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<DescribeImportCommandOutput, SdkError | ImportNotFoundError>
/**
* @see {@link DescribeKinesisStreamingDestinationCommand}
*/
describeKinesisStreamingDestination(
args: DescribeKinesisStreamingDestinationCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
DescribeKinesisStreamingDestinationCommandOutput,
SdkError | InternalServerError | InvalidEndpointError | ResourceNotFoundError
>
/**
* @see {@link DescribeLimitsCommand}
*/
describeLimits(
args: DescribeLimitsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<DescribeLimitsCommandOutput, SdkError | InternalServerError | InvalidEndpointError>
/**
* @see {@link DescribeTableCommand}
*/
describeTable(
args: DescribeTableCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
DescribeTableCommandOutput,
SdkError | InternalServerError | InvalidEndpointError | ResourceNotFoundError
>
/**
* @see {@link DescribeTableReplicaAutoScalingCommand}
*/
describeTableReplicaAutoScaling(
args: DescribeTableReplicaAutoScalingCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<DescribeTableReplicaAutoScalingCommandOutput, SdkError | InternalServerError | ResourceNotFoundError>
/**
* @see {@link DescribeTimeToLiveCommand}
*/
describeTimeToLive(
args: DescribeTimeToLiveCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
DescribeTimeToLiveCommandOutput,
SdkError | InternalServerError | InvalidEndpointError | ResourceNotFoundError
>
/**
* @see {@link DisableKinesisStreamingDestinationCommand}
*/
disableKinesisStreamingDestination(
args: DisableKinesisStreamingDestinationCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
DisableKinesisStreamingDestinationCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| LimitExceededError
| ResourceInUseError
| ResourceNotFoundError
>
/**
* @see {@link EnableKinesisStreamingDestinationCommand}
*/
enableKinesisStreamingDestination(
args: EnableKinesisStreamingDestinationCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
EnableKinesisStreamingDestinationCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| LimitExceededError
| ResourceInUseError
| ResourceNotFoundError
>
/**
* @see {@link ExecuteStatementCommand}
*/
executeStatement(
args: ExecuteStatementCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
ExecuteStatementCommandOutput,
| SdkError
| ConditionalCheckFailedError
| DuplicateItemError
| InternalServerError
| ItemCollectionSizeLimitExceededError
| ProvisionedThroughputExceededError
| RequestLimitExceededError
| ResourceNotFoundError
| TransactionConflictError
>
/**
* @see {@link ExecuteTransactionCommand}
*/
executeTransaction(
args: ExecuteTransactionCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
ExecuteTransactionCommandOutput,
| SdkError
| IdempotentParameterMismatchError
| InternalServerError
| ProvisionedThroughputExceededError
| RequestLimitExceededError
| ResourceNotFoundError
| TransactionCanceledError
| TransactionInProgressError
>
/**
* @see {@link ExportTableToPointInTimeCommand}
*/
exportTableToPointInTime(
args: ExportTableToPointInTimeCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
ExportTableToPointInTimeCommandOutput,
| SdkError
| ExportConflictError
| InternalServerError
| InvalidExportTimeError
| LimitExceededError
| PointInTimeRecoveryUnavailableError
| TableNotFoundError
>
/**
* @see {@link GetItemCommand}
*/
getItem(
args: GetItemCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
GetItemCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| ProvisionedThroughputExceededError
| RequestLimitExceededError
| ResourceNotFoundError
>
/**
* @see {@link ImportTableCommand}
*/
importTable(
args: ImportTableCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<ImportTableCommandOutput, SdkError | ImportConflictError | LimitExceededError | ResourceInUseError>
/**
* @see {@link ListBackupsCommand}
*/
listBackups(
args: ListBackupsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<ListBackupsCommandOutput, SdkError | InternalServerError | InvalidEndpointError>
/**
* @see {@link ListContributorInsightsCommand}
*/
listContributorInsights(
args: ListContributorInsightsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<ListContributorInsightsCommandOutput, SdkError | InternalServerError | ResourceNotFoundError>
/**
* @see {@link ListExportsCommand}
*/
listExports(
args: ListExportsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<ListExportsCommandOutput, SdkError | InternalServerError | LimitExceededError>
/**
* @see {@link ListGlobalTablesCommand}
*/
listGlobalTables(
args: ListGlobalTablesCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<ListGlobalTablesCommandOutput, SdkError | InternalServerError | InvalidEndpointError>
/**
* @see {@link ListImportsCommand}
*/
listImports(
args: ListImportsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<ListImportsCommandOutput, SdkError | LimitExceededError>
/**
* @see {@link ListTablesCommand}
*/
listTables(
args: ListTablesCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<ListTablesCommandOutput, SdkError | InternalServerError | InvalidEndpointError>
/**
* @see {@link ListTagsOfResourceCommand}
*/
listTagsOfResource(
args: ListTagsOfResourceCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
ListTagsOfResourceCommandOutput,
SdkError | InternalServerError | InvalidEndpointError | ResourceNotFoundError
>
/**
* @see {@link PutItemCommand}
*/
putItem(
args: PutItemCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
PutItemCommandOutput,
| SdkError
| ConditionalCheckFailedError
| InternalServerError
| InvalidEndpointError
| ItemCollectionSizeLimitExceededError
| ProvisionedThroughputExceededError
| RequestLimitExceededError
| ResourceNotFoundError
| TransactionConflictError
>
/**
* @see {@link QueryCommand}
*/
query(
args: QueryCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
QueryCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| ProvisionedThroughputExceededError
| RequestLimitExceededError
| ResourceNotFoundError
>
/**
* @see {@link RestoreTableFromBackupCommand}
*/
restoreTableFromBackup(
args: RestoreTableFromBackupCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
RestoreTableFromBackupCommandOutput,
| SdkError
| BackupInUseError
| BackupNotFoundError
| InternalServerError
| InvalidEndpointError
| LimitExceededError
| TableAlreadyExistsError
| TableInUseError
>
/**
* @see {@link RestoreTableToPointInTimeCommand}
*/
restoreTableToPointInTime(
args: RestoreTableToPointInTimeCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
RestoreTableToPointInTimeCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| InvalidRestoreTimeError
| LimitExceededError
| PointInTimeRecoveryUnavailableError
| TableAlreadyExistsError
| TableInUseError
| TableNotFoundError
>
/**
* @see {@link ScanCommand}
*/
scan(
args: ScanCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
ScanCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| ProvisionedThroughputExceededError
| RequestLimitExceededError
| ResourceNotFoundError
>
/**
* @see {@link TagResourceCommand}
*/
tagResource(
args: TagResourceCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
TagResourceCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| LimitExceededError
| ResourceInUseError
| ResourceNotFoundError
>
/**
* @see {@link TransactGetItemsCommand}
*/
transactGetItems(
args: TransactGetItemsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
TransactGetItemsCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| ProvisionedThroughputExceededError
| RequestLimitExceededError
| ResourceNotFoundError
| TransactionCanceledError
>
/**
* @see {@link TransactWriteItemsCommand}
*/
transactWriteItems(
args: TransactWriteItemsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
TransactWriteItemsCommandOutput,
| SdkError
| IdempotentParameterMismatchError
| InternalServerError
| InvalidEndpointError
| ProvisionedThroughputExceededError
| RequestLimitExceededError
| ResourceNotFoundError
| TransactionCanceledError
| TransactionInProgressError
>
/**
* @see {@link UntagResourceCommand}
*/
untagResource(
args: UntagResourceCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
UntagResourceCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| LimitExceededError
| ResourceInUseError
| ResourceNotFoundError
>
/**
* @see {@link UpdateContinuousBackupsCommand}
*/
updateContinuousBackups(
args: UpdateContinuousBackupsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
UpdateContinuousBackupsCommandOutput,
SdkError | ContinuousBackupsUnavailableError | InternalServerError | InvalidEndpointError | TableNotFoundError
>
/**
* @see {@link UpdateContributorInsightsCommand}
*/
updateContributorInsights(
args: UpdateContributorInsightsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<UpdateContributorInsightsCommandOutput, SdkError | InternalServerError | ResourceNotFoundError>
/**
* @see {@link UpdateGlobalTableCommand}
*/
updateGlobalTable(
args: UpdateGlobalTableCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
UpdateGlobalTableCommandOutput,
| SdkError
| GlobalTableNotFoundError
| InternalServerError
| InvalidEndpointError
| ReplicaAlreadyExistsError
| ReplicaNotFoundError
| TableNotFoundError
>
/**
* @see {@link UpdateGlobalTableSettingsCommand}
*/
updateGlobalTableSettings(
args: UpdateGlobalTableSettingsCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
UpdateGlobalTableSettingsCommandOutput,
| SdkError
| GlobalTableNotFoundError
| IndexNotFoundError
| InternalServerError
| InvalidEndpointError
| LimitExceededError
| ReplicaNotFoundError
| ResourceInUseError
>
/**
* @see {@link UpdateItemCommand}
*/
updateItem(
args: UpdateItemCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
UpdateItemCommandOutput,
| SdkError
| ConditionalCheckFailedError
| InternalServerError
| InvalidEndpointError
| ItemCollectionSizeLimitExceededError
| ProvisionedThroughputExceededError
| RequestLimitExceededError
| ResourceNotFoundError
| TransactionConflictError
>
/**
* @see {@link UpdateKinesisStreamingDestinationCommand}
*/
updateKinesisStreamingDestination(
args: UpdateKinesisStreamingDestinationCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
UpdateKinesisStreamingDestinationCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| LimitExceededError
| ResourceInUseError
| ResourceNotFoundError
>
/**
* @see {@link UpdateTableCommand}
*/
updateTable(
args: UpdateTableCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
UpdateTableCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| LimitExceededError
| ResourceInUseError
| ResourceNotFoundError
>
/**
* @see {@link UpdateTableReplicaAutoScalingCommand}
*/
updateTableReplicaAutoScaling(
args: UpdateTableReplicaAutoScalingCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
UpdateTableReplicaAutoScalingCommandOutput,
SdkError | InternalServerError | LimitExceededError | ResourceInUseError | ResourceNotFoundError
>
/**
* @see {@link UpdateTimeToLiveCommand}
*/
updateTimeToLive(
args: UpdateTimeToLiveCommandInput,
options?: __HttpHandlerOptions
): Effect.Effect<
UpdateTimeToLiveCommandOutput,
| SdkError
| InternalServerError
| InvalidEndpointError
| LimitExceededError
| ResourceInUseError
| ResourceNotFoundError
>
}
Added in v1.0.0
tags
DynamoDBService
Signature
export declare const DynamoDBService: Context.Tag<DynamoDBService, DynamoDBService>
Added in v1.0.0