Output metadata

\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"Key\": {\n \"type\": \"string\",\n \"required\": true\n },\n \"LastModified\": {\n \"type\": \"string\",\n \"required\": true\n },\n \"ETag\": {\n \"type\": \"string\",\n \"required\": true\n },\n \"Size\": {\n \"type\": \"number\",\n \"required\": true\n },\n \"StorageClass\": {\n \"type\": \"string\",\n \"required\": true\n },\n \"Owner\": {\n \"type\": \"object\",\n \"properties\": {\n \"ID\": {\n \"type\": \"string\",\n \"required\": true\n }\n }\n }\n }\n}\n```\n

\n\n## Actions\n### Write File to S3 From a Provided Attachment\nGiven a filename and a URL to an attachment stored in the platform, transfers the contents of the attachment to AWS S3. The component returns a summary of the written file. AWS S3 always overwrites the contents of the file if it already exists.\n \n#### Expected input metadata\n - **bucketName** - name of S3 bucket to write the file to; Sufficient write permission is required;\n - **fileName** - Name of file/S3 object to write. Use `/` characters in the filename to create folders;\n - **attachmentUrl** - Url to the attachment stored in the platform. The contents of this attachment will be written to S3 without any transformation;\n\n#### Limitations\n* It is not possible to set the File/Object Metadata in S3\n* Files/Objects can not be so large that they can not fit in the memory of the component's docker container.\n* Files/Objects can not be more that 5 GB in size\n* It is not possible to set the AWS S3 Storage Class for written files/objects. They will always be written with the `standard` storage class.\n* It is not possible to set file/object tags\n* It is not possible to compression objects/files (with zip, gzip, etc)\n* It is not possible to encrypt object/files\n\n### Read file \nRead file from S3 bucket.\nThis action reads file from S3 bucket by provided name. The result is storing in the output body (for json or xml) or in the output attachment (for other types).\nFile type resolves by it's extension. The name of attachment would be same to filename.\n\n#### List of Expected Config fields\n - **Default Bucket Name and folder** - name of S3 bucket to read file from (by default, if `bucketName` is not provided in metadata);\n \n#### Expected input metadata\n - **filename** - name of file at S3 bucket to read;\n - **bucketName** - name of S3 bucket to read file from (will replace `Default Bucket Name and folder` if provided, the field is optional).\n![image](https://user-images.githubusercontent.com/40201204/59688635-ced3bf80-91e6-11e9-8c17-a172a1dadce2.png)\n\n

Input metadata

\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"filename\": {\n \"type\": \"string\",\n \"required\": true\n },\n \"bucketName\": {\n \"type\": \"string\",\n \"required\": false\n }\n }\n}\n```\n

\n\n#### Expected output metadata\n\n

Output metadata

\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"filename\": {\n \"type\": \"string\",\n \"required\": true\n }\n }\n}\n```\n

\n\n### Get filenames\nEmit individually all filenames from S3 bucket.\nThis action gets all names of files which are storing in S3 bucket with provided name. \nThe filenames emits individually.\n\n**Notice**: if you provide bucket and folder (as example `eio-dev/inbound`), not only all names of files will return but name of root folder (`inbound/') as well.\n\n#### List of Expected Config fields\n - **Default Bucket Name and folder** - name of S3 bucket to read file from (by default, if `bucketName` is not provided in metadata);\n\n#### Expected input metadata\n - **bucketName** - name of S3 bucket to write file from (will replace `Default Bucket Name and folder` if provided, the field is optional).\n![image](https://user-images.githubusercontent.com/40201204/59688813-1fe3b380-91e7-11e9-8f54-a90b2b601eea.png)\n

Input metadata

\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"bucketName\": {\n \"type\": \"string\",\n \"required\": false\n }\n }\n}\n```\n

\n\n#### Expected output metadata\n\n

Output metadata

\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"ETag\": {\n \"type\": \"string\",\n \"required\": true\n },\n \"Location\": {\n \"type\": \"string\",\n \"required\": false\n },\n \"Key\": {\n \"type\": \"string\",\n \"required\": true\n },\n \"Bucket\": {\n \"type\": \"string\",\n \"required\": true\n }\n }\n}\n```\n

\n\n#### Known limitations\nIt is possible to retrieve maximum 1000 file names.\n\n### Delete file\nDelete file from S3 bucket.\n\nThis action removes file from S3 by provided name in selected bucket. The action will emit single filename of removed file.\n#### List of Expected Config fields\n - **Default Bucket Name and folder** - name of S3 bucket to delete file from (by default, if `bucketName` is not provided);\n#### Expected input metadata\n - **filename** - name of file at S3 bucket to delete;\n - **bucketName** - name of S3 bucket and folder to delete file from (will replace `Default Bucket Name and folder` if provided, the field is optional).\n![image](https://user-images.githubusercontent.com/40201204/59688635-ced3bf80-91e6-11e9-8c17-a172a1dadce2.png)\n\n

Input metadata

\n\n#### Expected output metadata\n\n

Output metadata

\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"filename\": {\n \"type\": \"string\",\n \"required\": true\n }\n }\n}\n```\n

\n\n### Rename file\nRename file in S3 bucket and folder.\n\nThis action renames file by provided name in selected bucket and folder.\nThe action will emit properties of renamed file.\n#### Expected input metadata\n - **bucketName** - name of S3 bucket where file is placed\n - **folder** - name of folder where file is placed (can be omitted)\n - **oldFileName** - name of file that should be renamed\n - **newFileName** - new name of file\n\n

Input metadata

\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"bucketName\": {\n \"title\":\"Bucket Name\",\n \"type\": \"string\",\n \"required\": true\n },\n \"folder\": {\n \"type\": \"string\",\n \"required\": false\n },\n \"oldFileName\": {\n \"type\": \"string\",\n \"required\": true\n },\n \"newFileName\": {\n \"type\": \"string\",\n \"required\": true\n }\n }\n}\n```\n

\n\n#### Expected output metadata\n\n

Output metadata

\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"Key\": {\n \"type\": \"string\",\n \"required\": true\n },\n \"LastModified\": {\n \"type\": \"string\",\n \"required\": true\n },\n \"ETag\": {\n \"type\": \"string\",\n \"required\": true\n },\n \"Size\": {\n \"type\": \"number\",\n \"required\": true\n },\n \"StorageClass\": {\n \"type\": \"string\",\n \"required\": true\n },\n \"Owner\": {\n \"type\": \"object\",\n \"required\": true,\n \"properties\": {\n \"ID\": {\n \"type\": \"string\",\n \"required\": true\n }\n }\n }\n }\n}\n```\n

\n\n### Write file\n**Deprecated in favor of [`Write File to S3 From a Provided Attachment`](#write-file-to-s3-from-a-provided-attachment)**\nPut stream as file into S3 bucket.\nThis action creates or rewrites a new file on S3 with the content that is passed as an input attachment.\nThe name of the file would be the same to the attachment name.\nBe careful: this action can process only one attachment - if it would be more or no attachment at all the execution would fail with exception.\n#### List of Expected Config fields\n - **Default Bucket Name and folder** - name of S3 bucket to write file in (by default, if `bucketName` is not provided in metadata);\n \n#### Expected input metadata\n - **filename** - name of resulted file at S3 bucket (optional);\n - **bucketName** - name of S3 bucket to write file in (will replace `Default Bucket Name and folder` if provided, the field is optional).\n \n![image](https://user-images.githubusercontent.com/40201204/59688384-448b5b80-91e6-11e9-8dd0-e007983055c8.png)\n\n

Input metadata

\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"filename\": {\n \"type\": \"string\",\n \"required\": false\n },\n \"bucketName\": {\n \"type\": \"string\",\n \"required\": false\n }\n }\n}\n```\n

\n\n#### Expected output metadata\n\n

Output metadata

\n\n### Stream to CSV\nAction is deprecated. Use the csv & or batch component to create a csv file first, then write that file to S3.\n\n## Known Limitations\n\n1. Maximal possible size for an attachment is 10 MB.\n2. Attachments mechanism does not work with [Local Agent Installation](https://support.elastic.io/support/solutions/articles/14000076461-announcing-the-local-agent-)\n\n## License\n\nApache-2.0 © [elastic.io GmbH](http://elastic.io)\n\n[daviddm-image]: https://david-dm.org/elasticio/aws-s3-component.svg?theme=shields.io\n[daviddm-url]: https://david-dm.org/elasticio/aws-s3-component\n","has_starred","hub_user","kendraflow","immutable_tags_settings",{"_76":11,"_77":78},"enabled","rules",[79],".*","is_automated","permissions",{"_83":21,"_84":11,"_85":11},"read","write","admin","user","storage_size",225667351,"orgData",{"_91":92,"_93":94,"_95":96,"_97":33,"_98":48,"_99":48,"_100":101,"_102":48,"_103":104,"_105":48,"_106":48,"_107":48,"_108":21},"id","75b3f7b362b7412cb7ac760293fbc627","uuid","75b3f7b3-62b7-412c-b7ac-760293fbc627","type","organization","orgname","full_name","location","company","Kendra Labs","profile_url","date_joined","2021-03-09T12:59:04.761152Z","gravatar_url","gravatar_email","badge","is_active","recentTags",[111],{"_112":44,"_113":114,"_115":116,"_91":117,"_118":119,"_50":136,"_137":114,"_138":33,"_139":56,"_57":140,"_141":142,"_143":127,"_144":136,"_145":66,"_146":21},"content_type","creator",12164293,"full_size",225656015,156941338,"images",[120],{"_121":122,"_123":124,"_125":48,"_126":127,"_128":129,"_130":131,"_132":48,"_133":-5,"_134":116,"_63":66,"_135":-5},"architecture","amd64","digest","sha256:233dfaf336c452ee27525817b58e8c9053da1952b15e0c45421158b69c3fc24d","features","last_pulled","2026-10-04T10:26:07.386391189Z","last_pushed","2021-07-05T11:46:54Z","os","linux","os_features","os_version","size","variant","2021-07-05T11:46:53.487856Z","last_updater","last_updater_username","media_type","latest","repository",14819838,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":160,"_167":168,"_154":177,"_178":11},{"_40":161,"_42":162,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":163,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":73,"_74":164,"_80":11,"_81":166,"_86":33,"_87":88},[],[44],[56],{"_76":11,"_77":165},[79],{"_83":21,"_84":11,"_85":11},"tags",{"_169":64,"_170":-5,"_171":-5,"_172":173},"count","next","previous","results",[174],{"_112":44,"_113":114,"_115":116,"_91":117,"_118":175,"_50":136,"_137":114,"_138":33,"_139":56,"_57":140,"_141":142,"_143":127,"_144":136,"_145":66,"_146":21},[176],{"_121":122,"_123":124,"_125":48,"_126":127,"_128":129,"_130":131,"_132":48,"_133":-5,"_134":116,"_63":66,"_135":-5},[],"canDeleteTags","actionData","errors"]

kendralabs/s3

Tags for kendralabs/s3