Inspector / Client / create_assessment_target

create_assessment_target#

Inspector.Client.create_assessment_target(**kwargs)#

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets.

See also: AWS API Documentation

Request Syntax

response = client.create_assessment_target(
    assessmentTargetName='string',
    resourceGroupArn='string'
)
Parameters:

  • assessmentTargetName (string) –

    [REQUIRED]

    The user-defined name that identifies the assessment target that you want to create. The name must be unique within the AWS account.

  • resourceGroupArn (string) – The ARN that specifies the resource group that is used to create the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.

Return type:

dict

Returns:

Response Syntax

{
    'assessmentTargetArn': 'string'
}

Response Structure

  • (dict) –

    • assessmentTargetArn (string) –

      The ARN that specifies the assessment target that is created.

Exceptions

  • Inspector.Client.exceptions.InternalException

  • Inspector.Client.exceptions.InvalidInputException

  • Inspector.Client.exceptions.LimitExceededException

  • Inspector.Client.exceptions.AccessDeniedException

  • Inspector.Client.exceptions.NoSuchEntityException

  • Inspector.Client.exceptions.InvalidCrossAccountRoleException

  • Inspector.Client.exceptions.ServiceTemporarilyUnavailableException

Examples

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account.

response = client.create_assessment_target(
    assessmentTargetName='ExampleAssessmentTarget',
    resourceGroupArn='arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv',
)

print(response)

Expected Output:

{
    'assessmentTargetArn': 'arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX',
    'ResponseMetadata': {
        '...': '...',
    },
}