Inspector / Client / describe_assessment_templates

describe_assessment_templates#

Inspector.Client.describe_assessment_templates(**kwargs)#

Describes the assessment templates that are specified by the ARNs of the assessment templates.

Request Syntax

response = client.describe_assessment_templates(
    assessmentTemplateArns=[
        'string',
    ]
)

Parameters:

assessmentTemplateArns (list) –

[REQUIRED]

(string) –

Return type:

dict

Returns:

Response Syntax

{
    'assessmentTemplates': [
        {
            'arn': 'string',
            'name': 'string',
            'assessmentTargetArn': 'string',
            'durationInSeconds': 123,
            'rulesPackageArns': [
                'string',
            ],
            'userAttributesForFindings': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'lastAssessmentRunArn': 'string',
            'assessmentRunCount': 123,
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'failedItems': {
        'string': {
            'failureCode': 'INVALID_ARN'|'DUPLICATE_ARN'|'ITEM_DOES_NOT_EXIST'|'ACCESS_DENIED'|'LIMIT_EXCEEDED'|'INTERNAL_ERROR',
            'retryable': True|False
        }
    }
}

Response Structure

(dict) –
- assessmentTemplates (list) –
  
  Information about the assessment templates.
  - (dict) –
    
    Contains information about an Amazon Inspector assessment template. This data type is used as the response element in the DescribeAssessmentTemplates action.
    - arn (string) –
      
      The ARN of the assessment template.
    - name (string) –
      
      The name of the assessment template.
    - assessmentTargetArn (string) –
      
      The ARN of the assessment target that corresponds to this assessment template.
    - durationInSeconds (integer) –
      
      The duration in seconds specified for this assessment template. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
    - rulesPackageArns (list) –
      
      The rules packages that are specified for this assessment template.
      - (string) –
    - userAttributesForFindings (list) –
      
      The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template.
      - (dict) –
        
        This data type is used as a request parameter in the AddAttributesToFindings and CreateAssessmentTemplate actions.
        
        key (string) –
        
        The attribute key.
        
        value (string) –
        
        The value assigned to the attribute key.
    - lastAssessmentRunArn (string) –
      
      The Amazon Resource Name (ARN) of the most recent assessment run associated with this assessment template. This value exists only when the value of assessmentRunCount is greaterpa than zero.
    - assessmentRunCount (integer) –
      
      The number of existing assessment runs associated with this assessment template. This value can be zero or a positive integer.
    - createdAt (datetime) –
      
      The time at which the assessment template is created.
- failedItems (dict) –
  
  Assessment template details that cannot be described. An error code is provided for each failed item.
  - (string) –
    - (dict) –
      
      Includes details about the failed items.
      - failureCode (string) –
        
        The status code of a failed item.
      - retryable (boolean) –
        
        Indicates whether you can immediately retry a request for this item for a specified resource.

Exceptions

Examples

Describes the assessment templates that are specified by the ARNs of the assessment templates.

response = client.describe_assessment_templates(
    assessmentTemplateArns=[
        'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw',
    ],
)

print(response)

Expected Output:

{
    'assessmentTemplates': [
        {
            'name': 'ExampleAssessmentTemplate',
            'arn': 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw',
            'assessmentRunCount': 0,
            'assessmentTargetArn': 'arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq',
            'createdAt': datetime(2016, 3, 15, 20, 36, 31, 1, 75, 0),
            'durationInSeconds': 3600,
            'rulesPackageArns': [
                'arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP',
            ],
            'userAttributesForFindings': [
            ],
        },
    ],
    'failedItems': {
    },
    'ResponseMetadata': {
        '...': '...',
    },
}