NetworkSecurityManagerClient
AWS Network Security Manager helps you centrally configure and deploy network security protections across your organization. Supported protections include AWS WAF and AWS Shield Advanced. This centralized approach reduces the overhead of managing protections individually across accounts and ensures consistent security at scale.
You define reusable rules and templates, then combine them into policies. Next, you select the accounts and resources to protect with scopes and roll the protections out with deployments. For example, you can define a set of AWS WAF rules and group them into a policy. Then deploy that policy across all accounts in your organization with a single deployment.
This API reference describes the operations and data types for AWS Network Security Manager.
For conceptual information, tutorials, and guidance on writing rule configurations, see the AWS Network Security Manager Developer Guide. For the default quotas that apply to your account, see Quotas. For the service endpoints available in each Region, see AWS Network Security Manager endpoints and quotas in the AWS General Reference.
Functions
Creates a deployment. A deployment applies one or more policies to the accounts and resources selected by a scope. Use isPublished to create the deployment in published (ACTIVE) or draft (DRAFT) state. The response includes coverage information and any warnings about the deployment.
Creates a snapshot of the current published version of the specified deployment.
Creates a policy. A policy combines templates and rules with enforcement settings for a firewall type, such as AWS WAF or AWS Shield Advanced. Use isPublished to create the policy in published (ACTIVE) or draft (DRAFT) state.
Creates a snapshot of the current published version of the specified policy.
Creates a rule. A rule defines a network security configuration to enforce, such as an AWS WAF rule group or configuration data. Use isPublished to create the rule in published (ACTIVE) or draft (DRAFT) state.
Creates a snapshot of the current published version of the specified rule. A snapshot is an immutable, versioned copy that other resources can reference.
Creates a scope. A scope selects the accounts and resources that a deployment applies to. Use isPublished to create the scope in published (ACTIVE) or draft (DRAFT) state.
Creates a snapshot of the current published version of the specified scope.
Creates a template. A template groups one or more rules to simplify reuse across policies. You can also associate rules with a policy directly, without a template. Use isPublished to create the template in published (ACTIVE) or draft (DRAFT) state.
Creates a snapshot of the current published version of the specified template.
Removes the specified AWS Network Security Manager administrator account.
Deletes the specified deployment.
Deletes the specified policy.
Deletes the specified rule.
Deletes the specified scope.
Deletes the specified template.
Generates a rule configuration from a natural-language description. Provide a prompt along with the rule's firewall type and rule type. The service returns a configuration that you can use when you create or update a rule. If you also provide an existing configuration, the service edits that configuration instead of generating a new one.
Retrieves the details of the specified AWS Network Security Manager administrator account.
Retrieves the details of the specified deployment, including coverage information and any warnings.
Retrieves the details of the specified policy.
Retrieves the details of the specified rule.
Retrieves the details of the specified scope.
Retrieves the details of the specified template.
Lists the AWS Network Security Manager administrator accounts in the organization.
Lists the aggregated synchronization statuses of resources across the deployments in your administrator account. You can filter the results by synchronization status and page through them.
Lists the deployments in the account. You can filter the results by status and page through them using maxResults and nextToken.
Lists the snapshots of the specified deployment.
Lists the policies in the account. You can filter the results by status and page through them using maxResults and nextToken.
Lists the snapshots of the specified policy.
Lists the resources associated with the specified resource.
Lists the synchronization statuses of the resources covered by the specified deployment. You can filter the results by synchronization status and page through them.
Lists the rules in the account. You can filter the results by status and page through them using maxResults and nextToken.
Lists the snapshots of the specified rule.
Lists the scopes in the account. You can filter the results by status and page through them using maxResults and nextToken.
Lists the snapshots of the specified scope.
Lists the tags associated with the specified resource.
Lists the templates in the account. You can filter the results by status and page through them using maxResults and nextToken.
Lists the snapshots of the specified template.
Sets the AWS account that serves as an AWS Network Security Manager administrator account, and optionally configures the scope of resources that the administrator can manage.
Adds or overwrites the specified tags on the given resource.
Removes the specified tags from the given resource.
Updates the specified deployment. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the deployment as a draft.
Updates the specified policy. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the policy as a draft.
Updates the specified rule. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the rule as a draft.
Updates the specified scope. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the scope as a draft.
Updates the specified template. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the template as a draft.
Inherited functions
Creates a deployment. A deployment applies one or more policies to the accounts and resources selected by a scope. Use isPublished to create the deployment in published (ACTIVE) or draft (DRAFT) state. The response includes coverage information and any warnings about the deployment.
Creates a snapshot of the current published version of the specified deployment.
Creates a policy. A policy combines templates and rules with enforcement settings for a firewall type, such as AWS WAF or AWS Shield Advanced. Use isPublished to create the policy in published (ACTIVE) or draft (DRAFT) state.
Creates a snapshot of the current published version of the specified policy.
Creates a rule. A rule defines a network security configuration to enforce, such as an AWS WAF rule group or configuration data. Use isPublished to create the rule in published (ACTIVE) or draft (DRAFT) state.
Creates a snapshot of the current published version of the specified rule. A snapshot is an immutable, versioned copy that other resources can reference.
Creates a scope. A scope selects the accounts and resources that a deployment applies to. Use isPublished to create the scope in published (ACTIVE) or draft (DRAFT) state.
Creates a snapshot of the current published version of the specified scope.
Creates a template. A template groups one or more rules to simplify reuse across policies. You can also associate rules with a policy directly, without a template. Use isPublished to create the template in published (ACTIVE) or draft (DRAFT) state.
Creates a snapshot of the current published version of the specified template.
Removes the specified AWS Network Security Manager administrator account.
Deletes the specified deployment.
Deletes the specified policy.
Deletes the specified rule.
Deletes the specified scope.
Deletes the specified template.
Generates a rule configuration from a natural-language description. Provide a prompt along with the rule's firewall type and rule type. The service returns a configuration that you can use when you create or update a rule. If you also provide an existing configuration, the service edits that configuration instead of generating a new one.
Retrieves the details of the specified AWS Network Security Manager administrator account.
Retrieves the details of the specified deployment, including coverage information and any warnings.
Retrieves the details of the specified policy.
Retrieves the details of the specified rule.
Retrieves the details of the specified scope.
Retrieves the details of the specified template.
Lists the AWS Network Security Manager administrator accounts in the organization.
Paginate over ListAdminAccountsResponse results.
Lists the aggregated synchronization statuses of resources across the deployments in your administrator account. You can filter the results by synchronization status and page through them.
Paginate over ListAggregateResourceSynchronizationStatusesResponse results.
Lists the deployments in the account. You can filter the results by status and page through them using maxResults and nextToken.
Lists the snapshots of the specified deployment.
Paginate over ListDeploymentSnapshotsResponse results.
Paginate over ListDeploymentsResponse results.
Lists the policies in the account. You can filter the results by status and page through them using maxResults and nextToken.
Paginate over ListPoliciesResponse results.
Lists the snapshots of the specified policy.
Paginate over ListPolicySnapshotsResponse results.
Lists the resources associated with the specified resource.
Paginate over ListResourceAssociationsResponse results.
Lists the synchronization statuses of the resources covered by the specified deployment. You can filter the results by synchronization status and page through them.
Paginate over ListResourceSynchronizationStatusesResponse results.
Lists the rules in the account. You can filter the results by status and page through them using maxResults and nextToken.
Lists the snapshots of the specified rule.
Paginate over ListRuleSnapshotsResponse results.
Paginate over ListRulesResponse results.
Lists the scopes in the account. You can filter the results by status and page through them using maxResults and nextToken.
Lists the snapshots of the specified scope.
Paginate over ListScopeSnapshotsResponse results.
Paginate over ListScopesResponse results.
Lists the tags associated with the specified resource.
Lists the templates in the account. You can filter the results by status and page through them using maxResults and nextToken.
Lists the snapshots of the specified template.
Paginate over ListTemplateSnapshotsResponse results.
Paginate over ListTemplatesResponse results.
Sets the AWS account that serves as an AWS Network Security Manager administrator account, and optionally configures the scope of resources that the administrator can manage.
Adds or overwrites the specified tags on the given resource.
Removes the specified tags from the given resource.
Updates the specified deployment. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the deployment as a draft.
Updates the specified policy. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the policy as a draft.
Updates the specified rule. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the rule as a draft.
Updates the specified scope. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the scope as a draft.
Updates the specified template. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the template as a draft.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.