AWS S3 v3.0.2

About the connector

To provide automation for AWS S3 operations, like creation and modification of S3 buckets and related contents.

This document provides information about the AWS S3 Connector, which facilitates automated interactions, with a AWS S3 server using FortiSOAR™ playbooks. Add the AWS S3 Connector as a step in FortiSOAR™ playbooks and perform automated operations with AWS S3.

Version information

Connector Version: 3.0.2

FortiSOAR™ Version Tested on: 7.5.0-4015

AWS S3 Version Tested on: 2006-03-01

Authored By: Fortinet

Certified: Yes

Release Notes for version 3.0.2

Following enhancements have been made to the AWS S3 Connector in version 3.0.2:

• Updated the version for boto3 library
• Updated the output schema for the following actions:
  • Delete Bucket
  • Modify Bucket
  • List Objects
  • List Buckets
  • Get Object
  • Create New Bucket

Installing the connector

Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-awss3

Prerequisites to configuring the connector

• You must know your account's AWS region that to access AWS services, the configuration type, and either the IAM Role or access credentials to connect to AWS.
  • If you choose access credentials, you need the AWS access key ID and the AWS secret access key to access AWS services.
  • If you choose IAM Role, you need the IAM role to access AWS S3 services.
• To create an AWS access key ID and the secret access key, you need to have Root User Access on AWS S3.

  To configure this connector using the IAM Role:

  • Your FortiSOAR™ machine must be on AWS
  • The user assigned to the IAM Role should have full access to execute FortiSOAR™ actions
• To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Minimum Permissions Required

• Not applicable

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the AWS S3 connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations:

operation: Create New Bucket

Input parameters

Output

The output contains the following populated JSON schema:

{
    "Location": "",
    "ResponseMetadata": {
        "RequestId": "",
        "RetryAttempts": "",
        "HostId": "",
        "HTTPHeaders": {
            "x-amz-request-id": "",
            "content-length": "",
            "date": "",
            "x-amz-id-2": "",
            "location": "",
            "server": ""
        },
        "HTTPStatusCode": ""
    }
}

operation: Download File

Input parameters

Output

The output contains the following populated JSON schema:

{
    "createUser": {
        "createUser": "",
        "id": "",
        "@type": "",
        "name": "",
        "@id": "",
        "userId": "",
        "userType": "",
        "createDate": "",
        "avatar": "",
        "modifyUser": "",
        "@settings": "",
        "modifyDate": ""
    },
    "id": "",
    "@type": "",
    "type": "",
    "modifyUser": {
        "createUser": "",
        "id": "",
        "@type": "",
        "name": "",
        "@id": "",
        "userId": "",
        "userType": "",
        "createDate": "",
        "avatar": "",
        "modifyUser": "",
        "@settings": "",
        "modifyDate": ""
    },
    "file": {
        "uploadDate": "",
        "owners": [],
        "@context": "",
        "mimeType": "",
        "@type": "",
        "filename": "",
        "@id": "",
        "file": {
            "@type": ""
        },
        "size": "",
        "metadata": ""
    },
    "@context": "",
    "description": "",
    "createDate": "",
    "name": "",
    "@id": "",
    "modifyDate": ""
}

operation: List Buckets

Input parameters

None.

Output

The output contains the following populated JSON schema:

{
    "Owner": {
        "ID": "",
        "DisplayName": ""
    },
    "Buckets": [
        {
            "Name": "",
            "CreationDate": ""
        }
    ],
    "ResponseMetadata": {
        "HostId": "",
        "RequestId": "",
        "HTTPHeaders": {
            "date": "",
            "server": "",
            "x-amz-id-2": "",
            "content-type": "",
            "x-amz-request-id": "",
            "transfer-encoding": ""
        },
        "RetryAttempts": "",
        "HTTPStatusCode": ""
    }
}

operation: Get Bucket Policy

Input parameters

Output

The output contains the following populated JSON schema:

{
    "ResponseMetadata": {
        "HTTPHeaders": {
            "server": "",
            "x-amz-id-2": "",
            "content-type": "",
            "date": "",
            "content-length": "",
            "x-amz-request-id": ""
        },
        "HostId": "",
        "RetryAttempts": "",
        "RequestId": "",
        "HTTPStatusCode": ""
    },
    "Policy": {
        "Version": "",
        "Statement": [
            {
                "Action": "",
                "Effect": "",
                "Resource": "",
                "Principal": {
                    "AWS": ""
                },
                "Sid": ""
            }
        ],
        "Id": ""
    }
}

operation: List Objects

Input parameters

Output

The output contains the following populated JSON schema:

{
    "Name": "",
    "Prefix": "",
    "MaxKeys": "",
    "Contents": [
        {
            "Key": "",
            "ETag": "",
            "Size": "",
            "Owner": {
                "ID": "",
                "DisplayName": ""
            },
            "LastModified": "",
            "StorageClass": ""
        }
    ],
    "KeyCount": "",
    "IsTruncated": "",
    "EncodingType": "",
    "ResponseMetadata": {
        "HostId": "",
        "RequestId": "",
        "HTTPHeaders": {
            "date": "",
            "server": "",
            "x-amz-id-2": "",
            "content-type": "",
            "x-amz-request-id": "",
            "transfer-encoding": "",
            "x-amz-bucket-region": ""
        },
        "RetryAttempts": "",
        "HTTPStatusCode": ""
    }
}

operation: Get Object

Input parameters

Output

The output contains the following populated JSON schema:

{
    "error": "",
    "response": {
        "acl": {
            "Owner": {
                "ID": "",
                "DisplayName": ""
            },
            "Grants": [
                {
                    "Grantee": {
                        "ID": "",
                        "Type": "",
                        "DisplayName": ""
                    },
                    "Permission": ""
                }
            ],
            "ResponseMetadata": {
                "HostId": "",
                "RequestId": "",
                "HTTPHeaders": {
                    "date": "",
                    "server": "",
                    "x-amz-id-2": "",
                    "content-type": "",
                    "x-amz-request-id": "",
                    "transfer-encoding": ""
                },
                "RetryAttempts": "",
                "HTTPStatusCode": ""
            }
        },
        "tags": {
            "TagSet": [],
            "ResponseMetadata": {
                "HostId": "",
                "RequestId": "",
                "HTTPHeaders": {
                    "date": "",
                    "server": "",
                    "x-amz-id-2": "",
                    "x-amz-request-id": "",
                    "transfer-encoding": ""
                },
                "RetryAttempts": "",
                "HTTPStatusCode": ""
            }
        }
    }
}

operation: Modify Bucket

Input parameters

Output

The output contains the following populated JSON schema:

{
    "tags": {
      "error": "",
      "result": {
        "ResponseMetadata": {
          "HostId": "",
          "RequestId": "",
          "HTTPHeaders": {
            "date": "",
            "server": "",
            "x-amz-id-2": "",
            "x-amz-request-id": ""
          },
          "RetryAttempts": "",
          "HTTPStatusCode": ""
        }
      }
    },
    "encryption": {
      "error": "",
      "result": {
        "ResponseMetadata": {
          "HostId": "",
          "RequestId": "",
          "HTTPHeaders": {
            "date": "",
            "server": "",
            "x-amz-id-2": "",
            "content-length": "",
            "x-amz-request-id": ""
          },
          "RetryAttempts": "",
          "HTTPStatusCode": ""
        }
      }
    }
}

operation: Modify Object

Input parameters

Output

The output contains the following populated JSON schema:

{
    "error": "",
    "result": {}
}

operation: Create Bucket Policy

Input parameters

Output

The output contains the following populated JSON schema:

{
    "ResponseMetadata": {
        "RetryAttempts": "",
        "HTTPHeaders": {
            "content-type": "",
            "x-amz-id-2": "",
            "transfer-encoding": "",
            "server": "",
            "x-amz-request-id": "",
            "date": ""
        },
        "HostId": "",
        "RequestId": "",
        "HTTPStatusCode": ""
    }
}

operation: Replace Bucket Policy

Input parameters

Output

The output contains the following populated JSON schema:

{
    "ResponseMetadata": {
        "RetryAttempts": "",
        "HTTPHeaders": {
            "content-type": "",
            "x-amz-id-2": "",
            "transfer-encoding": "",
            "server": "",
            "x-amz-request-id": "",
            "date": ""
        },
        "HostId": "",
        "RequestId": "",
        "HTTPStatusCode": ""
    }
}

operation: Upload File into Bucket

Input parameters

Output

The output contains the following populated JSON schema:

{
    "error": "",
    "result": {}
}

operation: Delete Tag

Input parameters

Output

The output contains a non-dictionary value.

operation: Delete Bucket

Input parameters

Output

The output contains the following populated JSON schema:

{
    "error": "",
    "result": {
        "ResponseMetadata": {
            "HostId": "",
            "RequestId": "",
            "HTTPHeaders": {
                "date": "",
                "server": "",
                "x-amz-id-2": "",
                "x-amz-request-id": ""
            },
            "RetryAttempts": "",
            "HTTPStatusCode": ""
        }
    }
}

operation: Delete Bucket Object

Input parameters

Output

The output contains the following populated JSON schema:

{
    "error": "",
    "result": {}
}

Included playbooks

The Sample - awss3 - 3.0.2 playbook collection comes bundled with the AWS S3 connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the AWS S3 connector.

• Create Bucket Policy
• Create New Bucket
• Delete Bucket
• Delete Bucket Object
• Delete Tag
• Download File
• Get Bucket Policy
• Get Object
• List Buckets
• List Objects
• Modify Bucket
• Modify Object
• Replace Bucket Policy
• Upload File into Bucket

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.