DeleteSQS

Description:

Deletes a message from an Amazon Simple Queuing Service Queue

Tags:

Amazon, AWS, SQS, Queue, Delete

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Queue URLQueue URLThe URL of the queue to act upon
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Receipt HandleReceipt Handle${sqs.receipt.handle}The identifier that specifies the receipt of the message
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Access Key IDAccess KeyNo Description Provided.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Secret Access KeySecret KeyNo Description Provided.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Credentials FileCredentials FilePath to a file containing AWS access key and secret key in properties file format.

This property requires exactly one file to be provided..
AWS Credentials Provider ServiceAWS Credentials Provider serviceController Service API:
AWSCredentialsProviderService
Implementation: AWSCredentialsProviderControllerService
The Controller Service that is used to obtain AWS credentials provider
RegionRegionUS West (Oregon)
  • AWS GovCloud (US-East) AWS Region Code : us-gov-east-1
  • AWS GovCloud (US-West) AWS Region Code : us-gov-west-1
  • Africa (Cape Town) AWS Region Code : af-south-1
  • Asia Pacific (Hong Kong) AWS Region Code : ap-east-1
  • Asia Pacific (Hyderabad) AWS Region Code : ap-south-2
  • Asia Pacific (Jakarta) AWS Region Code : ap-southeast-3
  • Asia Pacific (Melbourne) AWS Region Code : ap-southeast-4
  • Asia Pacific (Mumbai) AWS Region Code : ap-south-1
  • Asia Pacific (Osaka) AWS Region Code : ap-northeast-3
  • Asia Pacific (Seoul) AWS Region Code : ap-northeast-2
  • Asia Pacific (Singapore) AWS Region Code : ap-southeast-1
  • Asia Pacific (Sydney) AWS Region Code : ap-southeast-2
  • Asia Pacific (Tokyo) AWS Region Code : ap-northeast-1
  • Canada (Central) AWS Region Code : ca-central-1
  • Canada West (Calgary) AWS Region Code : ca-west-1
  • China (Beijing) AWS Region Code : cn-north-1
  • China (Ningxia) AWS Region Code : cn-northwest-1
  • Europe (Frankfurt) AWS Region Code : eu-central-1
  • Europe (Ireland) AWS Region Code : eu-west-1
  • Europe (London) AWS Region Code : eu-west-2
  • Europe (Milan) AWS Region Code : eu-south-1
  • Europe (Paris) AWS Region Code : eu-west-3
  • Europe (Spain) AWS Region Code : eu-south-2
  • Europe (Stockholm) AWS Region Code : eu-north-1
  • Europe (Zurich) AWS Region Code : eu-central-2
  • Israel (Tel Aviv) AWS Region Code : il-central-1
  • Middle East (Bahrain) AWS Region Code : me-south-1
  • Middle East (UAE) AWS Region Code : me-central-1
  • South America (Sao Paulo) AWS Region Code : sa-east-1
  • US East (N. Virginia) AWS Region Code : us-east-1
  • US East (Ohio) AWS Region Code : us-east-2
  • US ISO East AWS Region Code : us-iso-east-1
  • US ISO WEST AWS Region Code : us-iso-west-1
  • US ISOB East (Ohio) AWS Region Code : us-isob-east-1
  • US West (N. California) AWS Region Code : us-west-1
  • US West (Oregon) AWS Region Code : us-west-2
  • aws-cn-global AWS Region Code : aws-cn-global
  • aws-global AWS Region Code : aws-global
  • aws-iso-b-global AWS Region Code : aws-iso-b-global
  • aws-iso-global AWS Region Code : aws-iso-global
  • aws-us-gov-global AWS Region Code : aws-us-gov-global
No Description Provided.
Communications TimeoutCommunications Timeout30 secsNo Description Provided.
Endpoint Override URLEndpoint Override URLEndpoint URL to use instead of the AWS default including scheme, host, port, and path. The AWS libraries select an endpoint URL based on the AWS region, but this property overrides the selected endpoint URL, allowing use with other S3-compatible endpoints.
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy HostProxy HostProxy host name or IP
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Host PortProxy Host PortProxy host port
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Usernameproxy-user-nameProxy username
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Passwordproxy-user-passwordProxy password
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)

Relationships:

NameDescription
successFlowFiles are routed to success relationship
failureFlowFiles are routed to failure relationship

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.

See Also:

GetSQS, PutSQS