AuditManager / Client / get_services_in_scope

get_services_in_scope#

AuditManager.Client.get_services_in_scope()#

Gets a list of the Amazon Web Services from which Audit Manager can collect evidence.

Audit Manager defines which Amazon Web Services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding Amazon Web Services that are in this list.

Note

For information about why it’s no longer possible to specify services in scope manually, see I can’t edit the services in scope for my assessment in the Troubleshooting section of the Audit Manager user guide.

See also: AWS API Documentation

Request Syntax

response = client.get_services_in_scope()
Return type:

dict

Returns:

Response Syntax

{
    'serviceMetadata': [
        {
            'name': 'string',
            'displayName': 'string',
            'description': 'string',
            'category': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • serviceMetadata (list) –

      The metadata that’s associated with the Amazon Web Service.

      • (dict) –

        The metadata that’s associated with the Amazon Web Service.

        • name (string) –

          The name of the Amazon Web Service.

        • displayName (string) –

          The display name of the Amazon Web Service.

        • description (string) –

          The description of the Amazon Web Service.

        • category (string) –

          The category that the Amazon Web Service belongs to, such as compute, storage, or database.

Exceptions

  • AuditManager.Client.exceptions.AccessDeniedException

  • AuditManager.Client.exceptions.ValidationException

  • AuditManager.Client.exceptions.InternalServerException