AWS - SQS

Amazon Web Services Simple Queuing Service (SQS).

IT Services · AWS - SQS

Details

IDAWS - SQS
ProviderAmazon
CategoryIT Services
From Version5.0.0
Docker Imagedemisto/boto3py3:1.0.0.10325753
Supported ModulesAgentix XSIAM

README

Amazon Web Services Simple Queuing Service (SQS)

For more information regarding the AWS SQS service, please visit the official documentation found here.

For detailed instructions about setting up authentication, see: AWS Integrations - Authentication.

Configure AWS - SQS in Cortex

Parameter Description Required
AWS Default Region The AWS Region for this instance of the integration. For example, us-west-2 False
Role Arn The Amazon Resource Name (ARN) role used for EC2 instance authentication. If this is used, an access key and secret key are not required. False
Role Session Name A descriptive name for the assumed role session. For example, xsiam-IAM.integration-Role_SESSION False
Access Key The access key ID used for authentication, that was configured during IAM user configuration. If this is used, Role ARN is not required. False
Secret Key The secret key used for authentication, that was configured during IAM user configuration. If this is used, Role ARN is not required. False
Role Session Duration The maximum length of each session in seconds. Default: 900 seconds. The XSOAR integration will have the permissions assigned only when the session is initiated and for the defined duration. False
Queue URL URL of an existing Amazon SQS queue. False
Timeout The time in seconds till a timeout exception is reached. You can specify just the read timeout (for example 60) or also the connect timeout followed after a comma (for example 60,10). If a connect timeout is not specified a default of 10 second will be used. False
Retries The maximum number of retry attempts when connection or throttling errors are encountered. Set to 0 to disable retries. The default value is 5 and the limit is 10. Note: Increasing the number of retries will increase the execution time. More details about the retries strategy is available here. False
Fetch incidents   False
Maximum incidents for one fetch. Hard cap of 100. Maximum number of incidents for a single fetch. 10
First fetch timestamp First fetch query <number> <time unit>, e.g., 7 days. Default 3 days) False
Incident type   False
Use system proxy settings   False
Trust any certificate (not secure)   False
Parse SQS message body as a JSON string   False

There are three options to sign in to the service

  1. Provide Access Key ID and Secret Key ID.
  2. Provide Role ARN and Access Key ID and Secret Key ID.
  3. Do not provide any credentials or Role ARN other than permissions pulled from the service metadata.

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

aws-sqs-get-queue-url

Returns the URL of an existing queue. To access a queue that belongs to another AWS account, use the queueOwnerAWSAccountId parameter to specify the account ID of the queues owner. The queues owner must grant you permission to access the queue.

Base Command

aws-sqs-get-queue-url

Input

Argument Name Description Required
queueName The name of the queue. Required
queueOwnerAWSAccountId The AWS account ID of the account that created the queue. Optional
region The AWS Region, if not specified the default region will be used. Optional
roleArn The Amazon Resource Name (ARN) of the role to assume. Optional
roleSessionName An identifier for the assumed role session. Optional
roleSessionDuration The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. Optional

Context Output

Path Type Description
AWS.SQS.Queues.QueueUrl string The URL of the queue.

Command Example

!aws-sqs-get-queue-url queueName=test

Human Readable Output

AWS SQS Queues

| QueueUrl | test.queue.amazonaws.com/1234567/test |
| — | — |

aws-sqs-list-queues

Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

Base Command

aws-sqs-list-queues

Input

Argument Name Description Required
queueNamePrefix A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue names are case-sensitive. Optional
region The AWS Region, if not specified the default region will be used. Optional
roleArn The Amazon Resource Name (ARN) of the role to assume. Optional
roleSessionName An identifier for the assumed role session. Optional
roleSessionDuration The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. Optional

Context Output

Path Type Description
AWS.SQS.Queues.QueueUrl string The URL of the queue.

Command Example

!aws-sqs-list-queues

Human Readable Output

AWS SQS Queues

QueueUrl
test.queue.amazonaws.com/1234567/test1
test.queue.amazonaws.com/1234567/test2

aws-sqs-send-message

Delivers a message to the specified queue.

Base Command

aws-sqs-send-message

Input

Argument Name Description Required
queueUrl The URL of the Amazon SQS queue to which a message is sent. Required
messageBody The message to send. The maximum string size is 256 KB. Required
delaySeconds The length of time, in seconds, for which to delay a specific message. Valid values 0 to 900. Maximum 15 minutes. Optional
messageGroupId This parameter applies only to FIFO queues. The tag that specifies that a message belongs to a specific message group. Optional
region The AWS Region, if not specified the default region will be used. Optional
roleArn The Amazon Resource Name (ARN) of the role to assume. Optional
roleSessionName An identifier for the assumed role session. Optional
roleSessionDuration The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. Optional

Context Output

Path Type Description
AWS.SQS.Queues.SentMessages.MD5OfMessageBody string An MD5 digest of the non-URL-encoded message attribute string.
AWS.SQS.Queues.SentMessages.MD5OfMessageAttributes string An MD5 digest of the non-URL-encoded message attribute string.
AWS.SQS.Queues.SentMessages.MessageId string An attribute containing the MessageId of the message sent to the queue.
AWS.SQS.Queues.SentMessages.SequenceNumber string This parameter applies only to FIFO (first-in-first-out) queues. The large, non-consecutive number that Amazon SQS assigns to each message.

Command Example

!aws-sqs-send-message queueUrl=test.queue.amazonaws.com/1234567/test2 messageBody="test"

Human Readable Output

AWS SQS Queues sent messages

MD5OfMessageBody 123a4bcd4621d373cade4e832627b4f6
MessageId 1a2bc456-1e23-45e6-b789-b1af23c4f56f
QueueUrl test.queue.amazonaws.com/1234567/test2

aws-sqs-create-queue

Creates a new standard or FIFO queue. You can pass one or more attributes in the request.

Base Command

aws-sqs-create-queue

Input

Argument Name Description Required
queueName The name of the new queue. Required
delaySeconds The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values An integer from 0 to 900 seconds (15 minutes). The default is 0 (zero). Optional
maximumMessageSize The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB). Optional
messageRetentionPeriod The length of time, in seconds, for which Amazon SQS retains a message. Valid values An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default is 345,600 (4 days). Optional
receiveMessageWaitTimeSeconds The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values An integer from 0 to 20 (seconds). The default is 0 (zero). Optional
visibilityTimeout The visibility timeout for the queue. Valid values An integer from 0 to 43,200 (12 hours). The default is 30. Optional
kmsDataKeyReusePeriodSeconds The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. Optional
kmsMasterKeyId The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. Optional
policy The queues policy. A valid AWS policy. Optional
fifoQueue Designates a queue as FIFO. Possible values are: True, False. Optional
contentBasedDeduplication Enables content-based deduplication. Possible values are: True, False. Optional
region The AWS Region, if not specified the default region will be used. Optional
roleArn The Amazon Resource Name (ARN) of the role to assume. Optional
roleSessionName An identifier for the assumed role session. Optional
roleSessionDuration The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. Optional

Context Output

Path Type Description
AWS.SQS.Queues.QueueUrl unknown The URL of the created Amazon SQS queue.

Command Example

!aws-sqs-create-queue queueName=test3

Human Readable Output

AWS SQS Queues

| QueueUrl | test.queue.amazonaws.com/1234567/test3 |
| — | — |

aws-sqs-delete-queue

Deletes the queue specified by the QueueUrl , regardless of the queue’s contents. If the specified queue doesn’t exist, Amazon SQS returns a successful response.

Base Command

aws-sqs-delete-queue

Input

Argument Name Description Required
queueUrl The URL of the Amazon SQS queue to delete. Required
region The AWS Region, if not specified the default region will be used. Optional
roleArn The Amazon Resource Name (ARN) of the role to assume. Optional
roleSessionName An identifier for the assumed role session. Optional
roleSessionDuration The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. Optional

Context Output

There is no context output for this command.

Command Example

!aws-sqs-delete-queue queueUrl=example.com/123456789/test3

Human Readable Output

The Queue has been deleted

aws-sqs-purge-queue

Deletes the messages in a queue specified by the QueueURL parameter.

Base Command

aws-sqs-purge-queue

Input

Argument Name Description Required
queueUrl The URL of the queue from which the PurgeQueue action deletes messages. Required
region The AWS Region, if not specified the default region will be used. Optional
roleArn The Amazon Resource Name (ARN) of the role to assume. Optional
roleSessionName An identifier for the assumed role session. Optional
roleSessionDuration The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. Optional

Context Output

There is no context output for this command.

Command Example

!aws-sqs-purge-queue queueUrl=example.com/123456789/test2

Human Readable Output

The Queue has been Purged

Configuration parameters

  • defaultRegion — AWS Default Region (required)
  • roleArn — Role Arn
  • roleSessionName — Role Session Name
  • credentials — Access Key
  • access_key — Access Key
  • secret_key — Secret Key
  • sessionDuration — Role Session Duration
  • queueUrl — QueueURL
  • timeout — Timeout
  • retries — Retries
  • isFetch — Fetch incidents
  • max_fetch — Maximum incidents for one fetch. Hard cap of 100.
  • first_fetch — First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)
  • incidentType — Incident type
  • incidentFetchInterval — Incidents Fetch Interval
  • sts_regional_endpoint — AWS STS Regional Endpoints
  • proxy — Use system proxy settings
  • insecure — Trust any certificate (not secure)
  • parse_body_as_json — Parse SQS message body as a JSON string

Commands (6)

  • aws-sqs-create-queue

    Creates a new standard or FIFO queue. You can pass one or more attributes in the request.

  • aws-sqs-delete-queue

    Deletes the queue specified by the QueueUrl , regardless of the queue's contents. If the specified queue doesn't exist, Amazon SQS returns a successful response.

  • aws-sqs-get-queue-url

    Returns the URL of an existing queue. To access a queue that belongs to another AWS account, use the queueOwnerAWSAccountId parameter to specify the account ID of the queues owner. The queues owner must grant you permission to access the queue.

  • aws-sqs-list-queues

    Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

  • aws-sqs-purge-queue

    Deletes the messages in a queue specified by the QueueURL parameter.

  • aws-sqs-send-message

    Delivers a message to the specified queue.

Source

AWS-SQS.py AWS-SQS_test.py AWS-SQS.yml
Download History Raw 
commonfields:
  id: AWS - SQS
  version: -1
sectionorder:
- Connect
- Collect
name: AWS - SQS
display: AWS - SQS
category: IT Services
provider: Amazon
description: Amazon Web Services Simple Queuing Service (SQS).
configuration:
- display: AWS Default Region
  name: defaultRegion
  defaultvalue: ""
  type: 0
  section: Connect
  advanced: true
  required: true
- additionalinfo: When using Access Key and Secret Key, there is no need to use Role Arn
  display: Role Arn
  name: roleArn
  defaultvalue: ""
  type: 0
  section: Connect
  advanced: true
  required: false
- display: Role Session Name
  name: roleSessionName
  defaultvalue: ""
  type: 0
  section: Connect
  advanced: true
  required: false
- display: Access Key
  name: credentials
  section: Connect
  type: 9
  displaypassword: Secret Key
  required: false
- display: Access Key
  name: access_key
  type: 0
  section: Connect
  hidden: true
  required: false
- display: Secret Key
  name: secret_key
  type: 4
  section: Connect
  hidden: true
  required: false
- display: Role Session Duration
  name: sessionDuration
  defaultvalue: ""
  type: 0
  section: Connect
  advanced: true
  required: false
- display: QueueURL
  name: queueUrl
  defaultvalue: ''
  type: 0
  section: Collect
  required: false
- display: Timeout
  name: timeout
  defaultvalue: ''
  additionalinfo: "The time in seconds till a timeout exception is reached. You can specify just the read timeout (for example 60) or also the connect timeout followed after a comma (for example 60,10). If a connect timeout is not specified, a default of 10 second will be used."
  type: 0
  section: Connect
  advanced: true
  required: false
- display: Retries
  name: retries
  type: 0
  section: Connect
  defaultvalue: 5
  additionalinfo: "The maximum number of retry attempts when connection or throttling errors are encountered. Set to 0 to disable retries. The default value is 5 and the limit is 10. Note: Increasing the number of retries will increase the execution time."
  advanced: true
  required: false
- display: 'Fetch incidents'
  name: isFetch
  type: 8
  section: Collect
  required: false
- defaultvalue: '10'
  display: 'Maximum incidents for one fetch. Hard cap of 100.'
  name: max_fetch
  type: 0
  section: Collect
  required: false
- display: First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)
  name: first_fetch
  type: 0
  section: Collect
  defaultvalue: 7 days
  required: false
  hidden: true
- display: Incident type
  name: incidentType
  type: 13
  section: Connect
  required: false
- display: Incidents Fetch Interval
  name: incidentFetchInterval
  defaultvalue: '1'
  required: false
  type: 19
  section: Collect
  advanced: true
- display: AWS STS Regional Endpoints
  additionalinfo: Sets the AWS_STS_REGIONAL_ENDPOINTS environment variable to specify the AWS STS endpoint resolution logic. By default, this option is set to “legacy” in AWS. Leave empty if the environment variable is already set using server configuration.
  name: sts_regional_endpoint
  options:
  - legacy
  - regional
  type: 15
  section: Connect
  required: false
- display: Use system proxy settings
  name: proxy
  type: 8
  section: Connect
  advanced: true
  required: false
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  section: Connect
  advanced: true
  required: false
- display: Parse SQS message body as a JSON string
  name: parse_body_as_json
  type: 8
  section: Collect
  advanced: true
  required: false
script:
  script: ''
  type: python
  subtype: python3
  commands:
  - name: aws-sqs-get-queue-url
    arguments:
    - name: queueName
      required: true
      description: The name of the queue.
    - name: queueOwnerAWSAccountId
      description: The AWS account ID of the account that created the queue.
    - name: region
      description: The AWS Region, if not specified the default region will be used.
    - name: roleArn
      description: The Amazon Resource Name (ARN) of the role to assume.
    - name: roleSessionName
      description: An identifier for the assumed role session.
    - name: roleSessionDuration
      description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.
    outputs:
    - contextPath: AWS.SQS.Queues.QueueUrl
      description: The URL of the queue.
      type: string
    description: Returns the URL of an existing queue. To access a queue that belongs to another AWS account, use the queueOwnerAWSAccountId parameter to specify the account ID of the queues owner. The queues owner must grant you permission to access the queue.
  - name: aws-sqs-list-queues
    arguments:
    - name: queueNamePrefix
      description: A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.  Queue names are case-sensitive.
    - name: region
      description: The AWS Region, if not specified the default region will be used.
    - name: roleArn
      description: The Amazon Resource Name (ARN) of the role to assume.
    - name: roleSessionName
      description: An identifier for the assumed role session.
    - name: roleSessionDuration
      description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.
    outputs:
    - contextPath: AWS.SQS.Queues.QueueUrl
      description: The URL of the queue.
      type: string
    description: Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.
  - name: aws-sqs-send-message
    arguments:
    - name: queueUrl
      required: true
      description: The URL of the Amazon SQS queue to which a message is sent.
    - name: messageBody
      required: true
      description: The message to send. The maximum string size is 256 KB.
    - name: delaySeconds
      description: The length of time, in seconds, for which to delay a specific message. Valid values 0 to 900. Maximum 15 minutes.
    - name: messageGroupId
      description: This parameter applies only to FIFO queues. The tag that specifies that a message belongs to a specific message group.
    - name: region
      description: The AWS Region, if not specified the default region will be used.
    - name: roleArn
      description: The Amazon Resource Name (ARN) of the role to assume.
    - name: roleSessionName
      description: An identifier for the assumed role session.
    - name: roleSessionDuration
      description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.
    outputs:
    - contextPath: AWS.SQS.Queues.SentMessages.MD5OfMessageBody
      description: An MD5 digest of the non-URL-encoded message attribute string.
      type: string
    - contextPath: AWS.SQS.Queues.SentMessages.MD5OfMessageAttributes
      description: An MD5 digest of the non-URL-encoded message attribute string.
      type: string
    - contextPath: AWS.SQS.Queues.SentMessages.MessageId
      description: An attribute containing the MessageId of the message sent to the queue.
      type: string
    - contextPath: AWS.SQS.Queues.SentMessages.SequenceNumber
      description: This parameter applies only to FIFO (first-in-first-out) queues. The large, non-consecutive number that Amazon SQS assigns to each message.
      type: string
    description: Delivers a message to the specified queue.
  - name: aws-sqs-create-queue
    arguments:
    - name: queueName
      required: true
      description: The name of the new queue.
    - name: delaySeconds
      description: The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values An integer from 0 to 900 seconds (15 minutes). The default is 0 (zero).
    - name: maximumMessageSize
      description: The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).
    - name: messageRetentionPeriod
      description: The length of time, in seconds, for which Amazon SQS retains a message. Valid values An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default is 345,600 (4 days).
    - name: receiveMessageWaitTimeSeconds
      description: The length of time, in seconds, for which a ReceiveMessage  action waits for a message to arrive. Valid values An integer from 0 to 20 (seconds). The default is 0 (zero).
    - name: visibilityTimeout
      description: The visibility timeout for the queue. Valid values An integer from 0 to 43,200 (12 hours). The default is 30.
    - name: kmsDataKeyReusePeriodSeconds
      description: The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier.
    - name: kmsMasterKeyId
      description: The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.
    - name: policy
      description: The queues policy. A valid AWS policy.
    - name: fifoQueue
      auto: PREDEFINED
      predefined:
      - "True"
      - "False"
      description: Designates a queue as FIFO.
    - name: contentBasedDeduplication
      auto: PREDEFINED
      predefined:
      - "True"
      - "False"
      description: Enables content-based deduplication.
    - name: region
      description: The AWS Region, if not specified the default region will be used.
    - name: roleArn
      description: The Amazon Resource Name (ARN) of the role to assume.
    - name: roleSessionName
      description: An identifier for the assumed role session.
    - name: roleSessionDuration
      description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.
    outputs:
    - contextPath: AWS.SQS.Queues.QueueUrl
      description: The URL of the created Amazon SQS queue.
    description: Creates a new standard or FIFO queue. You can pass one or more attributes in the request.
  - name: aws-sqs-delete-queue
    arguments:
    - name: queueUrl
      required: true
      description: The URL of the Amazon SQS queue to delete.
    - name: region
      description: The AWS Region, if not specified the default region will be used.
    - name: roleArn
      description: The Amazon Resource Name (ARN) of the role to assume.
    - name: roleSessionName
      description: An identifier for the assumed role session.
    - name: roleSessionDuration
      description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.
    description: Deletes the queue specified by the QueueUrl , regardless of the queue's contents. If the specified queue doesn't exist, Amazon SQS returns a successful response.
  - name: aws-sqs-purge-queue
    arguments:
    - name: queueUrl
      required: true
      description: The URL of the queue from which the PurgeQueue action deletes messages.
    - name: region
      description: The AWS Region, if not specified the default region will be used.
    - name: roleArn
      description: The Amazon Resource Name (ARN) of the role to assume.
    - name: roleSessionName
      description: An identifier for the assumed role session.
    - name: roleSessionDuration
      description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.
    description: Deletes the messages in a queue specified by the QueueURL parameter.
  dockerimage: demisto/boto3py3:1.0.0.10325753
  isfetch: true
tests:
- AWS - SQS Test Playbook
fromversion: 5.0.0