FmsClient Class

Member Function Documentation

FmsClient::FmsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a FmsClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

FmsClient::FmsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads FmsClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AssociateAdminAccountResponse *FmsClient::associateAdminAccount(const AssociateAdminAccountRequest &request)

Sends request to the FmsClient service, and returns a pointer to an AssociateAdminAccountResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with a master account in AWS Organizations or associated with a member account that has the appropriate permissions. If the account ID that you submit is not an AWS Organizations master account, AWS Firewall Manager will set the appropriate permissions for the given member

account>

The account that you associate with AWS Firewall Manager is called the AWS Firewall manager administrator account.

[slot] DeleteNotificationChannelResponse *FmsClient::deleteNotificationChannel(const DeleteNotificationChannelRequest &request)

Sends request to the FmsClient service, and returns a pointer to an DeleteNotificationChannelResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS

[slot] DeletePolicyResponse *FmsClient::deletePolicy(const DeletePolicyRequest &request)

Sends request to the FmsClient service, and returns a pointer to an DeletePolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Permanently deletes an AWS Firewall Manager policy.

[slot] DisassociateAdminAccountResponse *FmsClient::disassociateAdminAccount(const DisassociateAdminAccountRequest &request)

Sends request to the FmsClient service, and returns a pointer to an DisassociateAdminAccountResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disassociates the account that has been set as the AWS Firewall Manager administrator account. You will need to submit an <code>AssociateAdminAccount</code> request to set a new account as the AWS Firewall

[slot] GetAdminAccountResponse *FmsClient::getAdminAccount(const GetAdminAccountRequest &request)

Sends request to the FmsClient service, and returns a pointer to an GetAdminAccountResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager

[slot] GetComplianceDetailResponse *FmsClient::getComplianceDetail(const GetComplianceDetailRequest &request)

Sends request to the FmsClient service, and returns a pointer to an GetComplianceDetailResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered non-compliant if the specified policy has not been applied to

[slot] GetNotificationChannelResponse *FmsClient::getNotificationChannel(const GetNotificationChannelRequest &request)

Sends request to the FmsClient service, and returns a pointer to an GetNotificationChannelResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS

[slot] GetPolicyResponse *FmsClient::getPolicy(const GetPolicyRequest &request)

Sends request to the FmsClient service, and returns a pointer to an GetPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about the specified AWS Firewall Manager

[slot] ListComplianceStatusResponse *FmsClient::listComplianceStatus(const ListComplianceStatusRequest &request)

Sends request to the FmsClient service, and returns a pointer to an ListComplianceStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns an array of <code>PolicyComplianceStatus</code> objects in the response. Use <code>PolicyComplianceStatus</code> to get a summary of which member accounts are protected by the specified policy.

[slot] ListPoliciesResponse *FmsClient::listPolicies(const ListPoliciesRequest &request)

Sends request to the FmsClient service, and returns a pointer to an ListPoliciesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns an array of <code>PolicySummary</code> objects in the

[slot] PutNotificationChannelResponse *FmsClient::putNotificationChannel(const PutNotificationChannelRequest &request)

Sends request to the FmsClient service, and returns a pointer to an PutNotificationChannelResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS

[slot] PutPolicyResponse *FmsClient::putPolicy(const PutPolicyRequest &request)

Sends request to the FmsClient service, and returns a pointer to an PutPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an AWS Firewall Manager