github.com/Jeffail/benthos/v3@v3.65.0/website/docs/components/inputs/sqs.md (about) 1 --- 2 title: sqs 3 type: input 4 status: deprecated 5 categories: ["Services","AWS"] 6 --- 7 8 <!-- 9 THIS FILE IS AUTOGENERATED! 10 11 To make changes please edit the contents of: 12 lib/input/sqs.go 13 --> 14 15 import Tabs from '@theme/Tabs'; 16 import TabItem from '@theme/TabItem'; 17 18 :::warning DEPRECATED 19 This component is deprecated and will be removed in the next major version release. Please consider moving onto [alternative components](#alternatives). 20 ::: 21 22 Receive messages from an Amazon SQS URL. 23 24 25 <Tabs defaultValue="common" values={[ 26 { label: 'Common', value: 'common', }, 27 { label: 'Advanced', value: 'advanced', }, 28 ]}> 29 30 <TabItem value="common"> 31 32 ```yaml 33 # Common config fields, showing default values 34 input: 35 label: "" 36 sqs: 37 url: "" 38 region: eu-west-1 39 ``` 40 41 </TabItem> 42 <TabItem value="advanced"> 43 44 ```yaml 45 # All config fields, showing default values 46 input: 47 label: "" 48 sqs: 49 url: "" 50 delete_message: true 51 region: eu-west-1 52 endpoint: "" 53 credentials: 54 profile: "" 55 id: "" 56 secret: "" 57 token: "" 58 role: "" 59 role_external_id: "" 60 timeout: 5s 61 max_number_of_messages: 1 62 ``` 63 64 </TabItem> 65 </Tabs> 66 67 ## Alternatives 68 69 This input is being replaced with the shiny new [`aws_sqs` input](/docs/components/inputs/aws_sqs), which has improved features, consider trying it out instead. 70 71 ### Credentials 72 73 By default Benthos will use a shared credentials file when connecting to AWS 74 services. It's also possible to set them explicitly at the component level, 75 allowing you to transfer data across accounts. You can find out more 76 [in this document](/docs/guides/cloud/aws). 77 78 ### Metadata 79 80 This input adds the following metadata fields to each message: 81 82 ```text 83 - sqs_message_id 84 - sqs_receipt_handle 85 - sqs_approximate_receive_count 86 - All message attributes 87 ``` 88 89 You can access these metadata fields using 90 [function interpolation](/docs/configuration/interpolation#metadata). 91 92 ## Fields 93 94 ### `url` 95 96 The SQS URL to consume from. 97 98 99 Type: `string` 100 Default: `""` 101 102 ### `delete_message` 103 104 Whether to delete the consumed message once it is acked. Disabling allows you to handle the deletion using a different mechanism. 105 106 107 Type: `bool` 108 Default: `true` 109 110 ### `region` 111 112 The AWS region to target. 113 114 115 Type: `string` 116 Default: `"eu-west-1"` 117 118 ### `endpoint` 119 120 Allows you to specify a custom endpoint for the AWS API. 121 122 123 Type: `string` 124 Default: `""` 125 126 ### `credentials` 127 128 Optional manual configuration of AWS credentials to use. More information can be found [in this document](/docs/guides/cloud/aws). 129 130 131 Type: `object` 132 133 ### `credentials.profile` 134 135 A profile from `~/.aws/credentials` to use. 136 137 138 Type: `string` 139 Default: `""` 140 141 ### `credentials.id` 142 143 The ID of credentials to use. 144 145 146 Type: `string` 147 Default: `""` 148 149 ### `credentials.secret` 150 151 The secret for the credentials being used. 152 153 154 Type: `string` 155 Default: `""` 156 157 ### `credentials.token` 158 159 The token for the credentials being used, required when using short term credentials. 160 161 162 Type: `string` 163 Default: `""` 164 165 ### `credentials.role` 166 167 A role ARN to assume. 168 169 170 Type: `string` 171 Default: `""` 172 173 ### `credentials.role_external_id` 174 175 An external ID to provide when assuming a role. 176 177 178 Type: `string` 179 Default: `""` 180 181 ### `timeout` 182 183 The period of time to wait before abandoning a request and trying again. 184 185 186 Type: `string` 187 Default: `"5s"` 188 189 ### `max_number_of_messages` 190 191 The maximum number of messages to consume from each request. 192 193 194 Type: `int` 195 Default: `1` 196 197