Cloud Connect AWS

Using the Cloud Connect AWS service collection

Table of Contents

Operation ID	Description
QueryAWSAccounts PEP 8 query_aws_accounts	Search for provisioned AWS Accounts by providing an FQL filter and paging details. Returns a set of AWS accounts which match the filter criteria
GetAWSSettings PEP 8 get_aws_settings	Retrieve a set of Global Settings which are applicable to all provisioned AWS accounts
GetAWSAccounts PEP 8 get_aws_accounts	Retrieve a set of AWS Accounts by specifying their IDs
ProvisionAWSAccounts PEP 8 provision_aws_accounts	Provision AWS Accounts by specifying details about the accounts to provision
DeleteAWSAccounts PEP 8 delete_aws_accounts	Delete a set of AWS Accounts by specifying their IDs
UpdateAWSAccounts PEP 8 update_aws_accounts	Update AWS Accounts by specifying the ID of the account and details to update
CreateOrUpdateAWSSettings PEP 8 create_or_update_aws_settings	Create or update Global Settings which are applicable to all provisioned AWS accounts
VerifyAWSAccountAccess PEP 8 verify_aws_account_access	Performs an Access Verification check on the specified AWS Account IDs
QueryAWSAccountsForIDs PEP 8 query_aws_accounts_for_ids	Search for provisioned AWS Accounts by providing an FQL filter and paging details. Returns a set of AWS account IDs which match the filter criteria

QueryAWSAccounts

Search for provisioned AWS Accounts by providing an FQL filter and paging details. Returns a set of AWS accounts which match the filter criteria

PEP8 method name

query_aws_accounts

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
limit			query	integer	The maximum records to return. [1-500]. Defaults to 100.
offset			query	integer	The offset to start retrieving records from.
sort			query	string	The property to sort by (e.g. alias.desc or state.asc).
filter			query	string	The filter expression that should be used to limit the results.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

response = falcon.query_aws_accounts(limit=integer,
                                     offset=integer,
                                     sort="string",
                                     filter="string"
                                     )
print(response)

Service class example (Operation ID syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

response = falcon.QueryAWSAccounts(limit=integer,
                                   offset=integer,
                                   sort="string",
                                   filter="string"
                                   )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("QueryAWSAccounts",
                          limit=integer,
                          offset=integer,
                          sort="string",
                          filter="string"
                          )
print(response)

GetAWSSettings

Retrieve a set of Global Settings which are applicable to all provisioned AWS accounts

PEP8 method name

get_aws_settings

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

No keywords or arguments accepted.

Usage

Service class example (PEP8 syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

response = falcon.get_aws_settings()
print(response)

Service class example (Operation ID syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

response = falcon.GetAWSSettings()
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("GetAWSSettings")
print(response)

GetAWSAccounts

Retrieve a set of AWS Accounts by specifying their IDs

PEP8 method name

get_aws_accounts

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
ids			query	string or list of strings	IDs of accounts to retrieve details.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_aws_accounts(ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.GetAWSAccounts(ids=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("GetAWSAccounts", ids=id_list)
print(response)

ProvisionAWSAccounts

Provision AWS Accounts by specifying details about the accounts to provision

PEP8 method name

provision_aws_accounts

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
body			body	string	Full BODY payload in JSON format.
cloudtrail_bucket_owner_id			body	string	AWS IAM IAD for Cloudtrail bucket owner. (ARN format)
cloudtrail_bucket_region			body	string	AWS region for Cloudtrail bucket.
external_id			body	string	Shared external ID to use for AWS cross-account role.
iam_role_arn			body	string	ARN for the IAM role to use as the cross-account role.
id			body	string	AWS account ID to provision.
mode			query	string	Mode for provisioning. Allowed values are manual or cloudformation. Defaults to manual if not defined.
parameters			query	string	Full query string parameters payload in JSON format.
rate_limit_req			body	integer	Rate limit count.
rate_limit_time			body	integer	Rate limit timestamp.

Usage

Service class example (PEP8 syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

response = falcon.provision_aws_accounts(mode="string",
                                         cloudtrail_bucket_owner_id="string",
                                         cloudtrail_bucket_region="string",
                                         external_id="string",
                                         iam_role_arn="string",
                                         id="string",
                                         rate_limit_req=integer,
                                         rate_limit_time=integer
                                         )
print(response)

Service class example (Operation ID syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

response = falcon.ProvisionAWSAccounts(mode="string",
                                       cloudtrail_bucket_owner_id="string",
                                       cloudtrail_bucket_region="string",
                                       external_id="string",
                                       iam_role_arn="string",
                                       id="string",
                                       rate_limit_req=integer,
                                       rate_limit_time=integer
                                       )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

BODY = {
    "resources": [
            {
                "cloudtrail_bucket_owner_id": "string",
                "cloudtrail_bucket_region": "string",
                "external_id": "string",
                "iam_role_arn": "string",
                "id": "string",
                "rate_limit_reqs": integer,
                "rate_limit_time": integer
            }
        ]
}

response = falcon.command("ProvisionAWSAccounts", mode="string", body=BODY)
print(response)

DeleteAWSAccounts

Delete a set of AWS Accounts by specifying their IDs

PEP8 method name

delete_aws_accounts

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
ids			query	string or list of strings	IDs of accounts to remove
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.delete_aws_accounts(ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.DeleteAWSAccounts(ids=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("DeleteAWSAccounts", ids=id_list)
print(response)

UpdateAWSAccounts

Update AWS Accounts by specifying the ID of the account and details to update

PEP8 method name

update_aws_accounts

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
body			body	string	Full BODY payload in JSON format.
cloudtrail_bucket_owner_id			body	string	AWS IAM IAD for Cloudtrail bucket owner. (ARN format)
cloudtrail_bucket_region			body	string	AWS region for Cloudtrail bucket.
external_id			body	string	Shared external ID to use for AWS cross-account role.
iam_role_arn			body	string	ARN for the IAM role to use as the cross-account role.
id			body	string	AWS account ID to provision.
rate_limit_req			body	integer	Rate limit count.
rate_limit_time			body	integer	Rate limit timestamp.

Usage

Service class example (PEP8 syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

response = falcon.update_aws_accounts(cloudtrail_bucket_owner_id="string",
                                      cloudtrail_bucket_region="string",
                                      external_id="string",
                                      iam_role_arn="string",
                                      id="string",
                                      rate_limit_req=integer,
                                      rate_limit_time=integer
                                      )
print(response)

Service class example (Operation ID syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

response = falcon.UpdateAWSAccounts(cloudtrail_bucket_owner_id="string",
                                    cloudtrail_bucket_region="string",
                                    external_id="string",
                                    iam_role_arn="string",
                                    id="string",
                                    rate_limit_req=integer,
                                    rate_limit_time=integer
                                    )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

BODY = {
    "resources": [
            {
                "cloudtrail_bucket_owner_id": "string",
                "cloudtrail_bucket_region": "string",
                "external_id": "string",
                "iam_role_arn": "string",
                "id": "string",
                "rate_limit_reqs": integer,
                "rate_limit_time": integer
            }
    ]
}

response = falcon.command("UpdateAWSAccounts", body=BODY)
print(response)

CreateOrUpdateAWSSettings

Create or update Global Settings which are applicable to all provisioned AWS accounts

PEP8 method name

create_or_update_aws_settings

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
body			body	string	Full BODY payload in JSON format.
cloudtrail_bucket_owner_id			body	string	AWS IAM IAD for Cloudtrail bucket owner. (ARN format)
static_external_id			body	string	New external ID to use for the AWS cross-account role.

Usage

Service class example (PEP8 syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

response = falcon.create_or_update_aws_settings(cloudtrail_bucket_owner_id="string"
                                                static_external_id="string"
                                                )
print(response)

Service class example (Operation ID syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

response = falcon.CreateOrUpdateAWSSettings(cloudtrail_bucket_owner_id="string"
                                            static_external_id="string"
                                            )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

BODY = {
    "resources": [
        {
            "cloudtrail_bucket_owner_id": "string",
            "static_external_id": "string"
        }
    ]
}

response = falcon.command("CreateOrUpdateAWSSettings", body=BODY)
print(response)

VerifyAWSAccountAccess

Performs an Access Verification check on the specified AWS Account IDs

PEP8 method name

verify_aws_account_access

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
ids			query	string or list of strings	IDs of accounts to verify access on.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.verify_aws_account_access(ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.VerifyAWSAccountAccess(ids=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("VerifyAWSAccountAccess", ids=id_list)
print(response)

QueryAWSAccountsForIDs

Search for provisioned AWS Accounts by providing an FQL filter and paging details. Returns a set of AWS account IDs which match the filter criteria

PEP8 method name

query_aws_accounts_for_ids

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
limit			query	integer	The maximum records to return. [1-500]. Defaults to 100.
offset			query	integer	The offset to start retrieving records from.
sort			query	string	The property to sort by (e.g. alias.desc or state.asc).
filter			query	string	The filter expression that should be used to limit the results.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

response = falcon.query_aws_accounts_for_ids(limit=integer,
                                             offset=integer,
                                             sort="string",
                                             filter="string"
                                             )
print(response)

Service class example (Operation ID syntax)

from falconpy import CloudConnectAWS

falcon = CloudConnectAWS(client_id="API_CLIENT_ID_HERE",
                         client_secret="API_CLIENT_SECRET_HERE"
                         )

response = falcon.QueryAWSAccountsForIDs(limit=integer,
                                         offset=integer,
                                         sort="string",
                                         filter="string"
                                         )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("QueryAWSAccountsForIDs",
                          limit=integer,
                          offset=integer,
                          sort="string",
                          filter="string"
                          )
print(response)