SQSService overview
Added in v1.0.0
Table of contents
constructors
makeSQSService
Signature
export declare const makeSQSService: Effect.Effect<any, unknown, unknown>
Added in v1.0.0
models
SQSService (class)
Signature
export declare class SQSService
Added in v1.0.0
SQSService$ (interface)
Signature
export interface SQSService$ {
/**
* @see {@link AddPermissionCommand}
*/
addPermission(
args: AddPermissionCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
AddPermissionCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| OverLimitError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link CancelMessageMoveTaskCommand}
*/
cancelMessageMoveTask(
args: CancelMessageMoveTaskCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CancelMessageMoveTaskCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| RequestThrottledError
| ResourceNotFoundError
| UnsupportedOperationError
>
/**
* @see {@link ChangeMessageVisibilityCommand}
*/
changeMessageVisibility(
args: ChangeMessageVisibilityCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ChangeMessageVisibilityCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| MessageNotInflightError
| QueueDoesNotExistError
| ReceiptHandleIsInvalidError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link ChangeMessageVisibilityBatchCommand}
*/
changeMessageVisibilityBatch(
args: ChangeMessageVisibilityBatchCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ChangeMessageVisibilityBatchCommandOutput,
| Cause.TimeoutError
| SdkError
| BatchEntryIdsNotDistinctError
| EmptyBatchRequestError
| InvalidAddressError
| InvalidBatchEntryIdError
| InvalidSecurityError
| QueueDoesNotExistError
| RequestThrottledError
| TooManyEntriesInBatchRequestError
| UnsupportedOperationError
>
/**
* @see {@link CreateQueueCommand}
*/
createQueue(
args: CreateQueueCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateQueueCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidAttributeNameError
| InvalidAttributeValueError
| InvalidSecurityError
| QueueDeletedRecentlyError
| QueueNameExistsError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link DeleteMessageCommand}
*/
deleteMessage(
args: DeleteMessageCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteMessageCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidIdFormatError
| InvalidSecurityError
| QueueDoesNotExistError
| ReceiptHandleIsInvalidError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link DeleteMessageBatchCommand}
*/
deleteMessageBatch(
args: DeleteMessageBatchCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteMessageBatchCommandOutput,
| Cause.TimeoutError
| SdkError
| BatchEntryIdsNotDistinctError
| EmptyBatchRequestError
| InvalidAddressError
| InvalidBatchEntryIdError
| InvalidSecurityError
| QueueDoesNotExistError
| RequestThrottledError
| TooManyEntriesInBatchRequestError
| UnsupportedOperationError
>
/**
* @see {@link DeleteQueueCommand}
*/
deleteQueue(
args: DeleteQueueCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteQueueCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link GetQueueAttributesCommand}
*/
getQueueAttributes(
args: GetQueueAttributesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetQueueAttributesCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidAttributeNameError
| InvalidSecurityError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link GetQueueUrlCommand}
*/
getQueueUrl(
args: GetQueueUrlCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetQueueUrlCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link ListDeadLetterSourceQueuesCommand}
*/
listDeadLetterSourceQueues(
args: ListDeadLetterSourceQueuesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListDeadLetterSourceQueuesCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
listDeadLetterSourceQueuesStream(
args: ListDeadLetterSourceQueuesCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
ListDeadLetterSourceQueuesCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link ListMessageMoveTasksCommand}
*/
listMessageMoveTasks(
args: ListMessageMoveTasksCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListMessageMoveTasksCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| RequestThrottledError
| ResourceNotFoundError
| UnsupportedOperationError
>
/**
* @see {@link ListQueueTagsCommand}
*/
listQueueTags(
args: ListQueueTagsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListQueueTagsCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link ListQueuesCommand}
*/
listQueues(
args: ListQueuesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListQueuesCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| RequestThrottledError
| UnsupportedOperationError
>
listQueuesStream(
args: ListQueuesCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
ListQueuesCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link PurgeQueueCommand}
*/
purgeQueue(
args: PurgeQueueCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PurgeQueueCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| PurgeQueueInProgressError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link ReceiveMessageCommand}
*/
receiveMessage(
args: ReceiveMessageCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ReceiveMessageCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| KmsAccessDeniedError
| KmsDisabledError
| KmsInvalidKeyUsageError
| KmsInvalidStateError
| KmsNotFoundError
| KmsOptInRequiredError
| KmsThrottledError
| OverLimitError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link RemovePermissionCommand}
*/
removePermission(
args: RemovePermissionCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
RemovePermissionCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link SendMessageCommand}
*/
sendMessage(
args: SendMessageCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
SendMessageCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidMessageContentsError
| InvalidSecurityError
| KmsAccessDeniedError
| KmsDisabledError
| KmsInvalidKeyUsageError
| KmsInvalidStateError
| KmsNotFoundError
| KmsOptInRequiredError
| KmsThrottledError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link SendMessageBatchCommand}
*/
sendMessageBatch(
args: SendMessageBatchCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
SendMessageBatchCommandOutput,
| Cause.TimeoutError
| SdkError
| BatchEntryIdsNotDistinctError
| BatchRequestTooLongError
| EmptyBatchRequestError
| InvalidAddressError
| InvalidBatchEntryIdError
| InvalidSecurityError
| KmsAccessDeniedError
| KmsDisabledError
| KmsInvalidKeyUsageError
| KmsInvalidStateError
| KmsNotFoundError
| KmsOptInRequiredError
| KmsThrottledError
| QueueDoesNotExistError
| RequestThrottledError
| TooManyEntriesInBatchRequestError
| UnsupportedOperationError
>
/**
* @see {@link SetQueueAttributesCommand}
*/
setQueueAttributes(
args: SetQueueAttributesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
SetQueueAttributesCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidAttributeNameError
| InvalidAttributeValueError
| InvalidSecurityError
| OverLimitError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link StartMessageMoveTaskCommand}
*/
startMessageMoveTask(
args: StartMessageMoveTaskCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
StartMessageMoveTaskCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| RequestThrottledError
| ResourceNotFoundError
| UnsupportedOperationError
>
/**
* @see {@link TagQueueCommand}
*/
tagQueue(
args: TagQueueCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
TagQueueCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
/**
* @see {@link UntagQueueCommand}
*/
untagQueue(
args: UntagQueueCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UntagQueueCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidAddressError
| InvalidSecurityError
| QueueDoesNotExistError
| RequestThrottledError
| UnsupportedOperationError
>
}
Added in v1.0.0
utils
SQSService (namespace)
Added in v1.0.0
Config (interface)
Signature
export interface Config extends Omit<SQSClientConfig, "logger"> {
readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}
Added in v1.0.0
Type (type alias)
Signature
export type Type = SQSService$
Added in v1.0.0