Actions, resources, and condition keys for AWS Security Agent
AWS Security Agent (service prefix: securityagent) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
Topics
Actions defined by AWS Security Agent
You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.
The Access level column of the Actions table describes how the action is classified (List, Read, Permissions management, or Tagging). This classification can help you understand the level of access that an action grants when you use it in a policy. For more information about access levels, see Access levels in policy summaries.
The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.
The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.
The Dependent actions column of the Actions table shows additional permissions that may be required to successfully call an action. These permissions may be needed in addition to the permission for the action itself. When an action specifies dependent actions, those dependencies may apply to additional resources defined for that action, not only the first resource listed in the table.
Note
Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.
For details about the columns in the following table, see Actions table.
| Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
|---|---|---|---|---|---|
| AddArtifact | Grants permission to add an Artifact for the given Agent Space | Write | |||
| BatchDeletePentests | Grants permission to delete multiple penetration tests in a single request | Write |
kms:Decrypt |
||
| BatchGetAgentSpaces | Grants permission to retrieve multiple agent spaces in a single request | Read |
kms:Decrypt |
||
| BatchGetArtifactMetadata | Grants permission to retrieve one or more Artifact Metadata records for the given Agent Space | Read | |||
| BatchGetFindings | Grants permission to retrieve multiple security testing findings in a single request | Read |
kms:Decrypt |
||
| BatchGetPentestJobContentMetadata | Grants permission to retrieve multiple pentest job contents metadata in a single request | Read |
kms:Decrypt |
||
| BatchGetPentestJobTasks | Grants permission to retrieve multiple pentest job tasks in a single request | Read |
kms:Decrypt |
||
| BatchGetPentestJobs | Grants permission to retrieve multiple security testing jobs in a single request | Read |
kms:Decrypt |
||
| BatchGetPentests | Grants permission to retrieve multiple penetration tests in a single request | Read |
kms:Decrypt |
||
| BatchGetTargetDomains | Grants permission to retrieve multiple target domains in a single request | Read | |||
| CreateAgentSpace | Grants permission to create an agent space record | Write |
kms:Decrypt kms:DescribeKey kms:GenerateDataKeyWithoutPlaintext |
||
| CreateApplication | Grants permission to create a new application | Write |
iam:PassRole kms:DescribeKey sso:CreateApplication |
||
| CreateDesignReview | Grants permission to create a design review | Write | |||
| CreateIntegration | Grants permission to create a security testing integration | Write | |||
| CreateMembership | Grants permission to add a single member to a agent space with specified role | Write | |||
| CreateOneTimeLoginSession | Grants permission to create a one time login session | Write | |||
| CreatePentest | Grants permission to create a new penetration test configuration | Write |
kms:Decrypt |
||
| CreateSecurityRequirement | Grants permission to add a customer managed Security Requirement | Write | |||
| CreateTargetDomain | Grants permission to create a target domain record | Write | |||
| DeleteAgentSpace | Grants permission to delete an agent space record | Write |
kms:Decrypt |
||
| DeleteApplication | Grants permission to delete application | Write | |||
| DeleteArtifact | Grants permission to delete an Artifact | Write | |||
| DeleteDesignReview | Grants permission to delete a design review | Write | |||
| DeleteIntegration | Grants permission to delete the integration of an application | Write | |||
| DeleteMembership | Grants permission to remove a single member associated to an agent space | Write | |||
| DeleteSecurityRequirement | Grants permission to delete a customer managed Security Requirement | Write | |||
| DeleteTargetDomain | Grants permission to delete a target domain record | Write | |||
| GetApplication | Grants permission to get application details by application ID | Read | |||
| GetArtifact | Grants permission to retrieve an Artifact for the given Agent Space | Read | |||
| GetDesignReview | Grants permission to get the status of the associated agent space design review | Read | |||
| GetDesignReviewArtifact | Grants permission to get design review artifact for a specific document | Read | |||
| GetDesignReviewFeedback | Grants permission to get feedback for a design review comment | Read | |||
| GetIntegration | Grants permission to get the integration metadata by ID | Read | |||
| GetSecurityRequirement | Grants permission to retrieve a Security Requirement | Read | |||
| InitiateProviderRegistration | Grants permission to initiate the registration of Security Agent App for the given provider (eg: GitHub) | Write | |||
| ListAgentSpaces | Grants permission to list agent spaces | List | |||
| ListApplications | Grants permission to list all applications in the account | List | |||
| ListArtifacts | Grants permission to list all artifacts for the given agent space | List | |||
| ListDesignReviewComments | Grants permission to list design review comments | List | |||
| ListDesignReviews | Grants permission to list all design reviews for the given agent space | List | |||
| ListDiscoveredEndpoints | Grants permission to list discovered endpoints associated with a pentest job with optional URI prefix filtering | List |
kms:Decrypt |
||
| ListFindings | Grants permission to list findings with filtering and pagination support | List |
kms:Decrypt |
||
| ListIntegratedResources | Grants permission to list integrated resources for an agent space | List | |||
| ListIntegrations | Grants permission to get the integrations owned by the caller's AWS account | List | |||
| ListMemberships | Grants permission to list all members associated to an agent space with pagination support | List | |||
| ListPentestJobTasks | Grants permission to list pentest job tasks associated with a pentest job | List |
kms:Decrypt |
||
| ListPentestJobsForPentest | Grants permission to list penetration test jobs associated with a penetration test | List |
kms:Decrypt |
||
| ListPentests | Grants permission to list penetration tests with optional filtering by status | List |
kms:Decrypt |
||
| ListResourcesFromIntegration | Grants permission to list resources from Integration | List | |||
| ListSecurityRequirements | Grants permission to list all Security Requirements | List | |||
| ListTagsForResource | Grants permission to list the tags for a resource | Read | |||
| ListTargetDomains | Grants permission to list target domains | List | |||
| PutDesignReviewFeedback | Grants permission to submit feedback for a design review comment | Write | |||
| StartCodeRemediation | Grants permission to start code remediation for the findings | Write |
kms:Decrypt kms:GenerateDataKey |
||
| StartPentestJob | Grants permission to initiate the execution of a penetration test | Write |
kms:Decrypt kms:GenerateDataKey |
||
| StopPentestJob | Grants permission to stop the execution of a running penetration test | Write |
kms:Decrypt |
||
| TagResource | Grants permission to add tags to a resource | Tagging | |||
| ToggleManagedSecurityRequirement | Grants permission to toggle the status of a managed Security Requirement | Write | |||
| UntagResource | Grants permission to remove tags from a resource | Tagging | |||
| UpdateAgentSpace | Grants permission to update an agent space record | Write |
kms:Decrypt |
||
| UpdateApplication | Grants permission to update application configuration | Write |
iam:PassRole kms:DescribeKey |
||
| UpdateFinding | Grants permission to update an existing security finding with new details or status | Write |
kms:Decrypt |
||
| UpdateIntegratedResources | Grants permission to update integrated resources for an agent space | Write | |||
| UpdatePentest | Grants permission to update an existing penetration test with new configuration or settings | Write |
kms:Decrypt |
||
| UpdateSecurityRequirement | Grants permission to update a customer managed Security Requirement | Write | |||
| UpdateTargetDomain | Grants permission to update a target domain record | Write | |||
| VerifyTargetDomain | Grants permission to verify ownership for a registered target domain | Write |
Resource types defined by AWS Security Agent
The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.
| Resource types | ARN | Condition keys |
|---|---|---|
| Application |
arn:${Partition}:securityagent:${Region}:${Account}:application/${ApplicationId}
|
|
| SecurityRequirementPack |
arn:${Partition}:securityagent:${Region}:${Account}:security-requirement-pack/${SecurityRequirementPackId}
|
|
| Integration |
arn:${Partition}:securityagent:${Region}:${Account}:integration/${IntegrationId}
|
|
| AgentSpace |
arn:${Partition}:securityagent:${Region}:${Account}:agent-space/${AgentId}
|
|
| TargetDomain |
arn:${Partition}:securityagent:${Region}:${Account}:target-domain/${TargetDomainId}
|
Condition keys for AWS Security Agent
AWS Security Agent defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.
To view the global condition keys that are available to all services, see AWS global condition context keys.
| Condition keys | Description | Type |
|---|---|---|
| aws:RequestTag/${TagKey} | Filters access by the tags that are passed in the request | String |
| aws:ResourceTag/${TagKey} | Filters access by the tags associated with the resource | String |
| aws:TagKeys | Filters access by the tag keys that are passed in the request | ArrayOfString |