ExStreamClient.Operations.CheckSqs (ExStreamClient v0.1.7)

Modules for interacting with the check_sqs group of Stream APIs

All functions in this module accept the following optional parameters:

api_key - API key to use. If not provided, the default key from config will be used
api_key_secret - API key secret to use. If not provided, the default secret from config will be used
endpoint - endpoint to use. If not provided, the default endpoint from config will be used
client - HTTP client to use. Must implement ExStreamClient.Http.Behavior. Defaults to ExStreamClient.Http
req_opts - all of these options will be forwarded to req. See Req.new/1 for available options

Summary

shared_opts()

Validates Amazon SQS credentials

@type shared_opts() :: [
  api_key: String.t(),
  api_key_secret: String.t(),
  client: module(),
  endpoint: String.t(),
  req_opts: keyword()
]

@spec check_sqs(ExStreamClient.Model.CheckSQSRequest.t(), shared_opts()) ::
  {:ok, ExStreamClient.Model.CheckSQSResponse.t()} | {:error, any()}

Validates Amazon SQS credentials