AuditManager / Client / get_delegations

get_delegations#

AuditManager.Client.get_delegations(**kwargs)#

Returns a list of delegations from an audit owner to a delegate.

Request Syntax

response = client.get_delegations(
    nextToken='string',
    maxResults=123
)

Parameters:

nextToken (string) – The pagination token that’s used to fetch the next set of results.
maxResults (integer) – Represents the maximum number of results on a page or for an API request call.

Return type:

dict

Returns:

Response Syntax

{
    'delegations': [
        {
            'id': 'string',
            'assessmentName': 'string',
            'assessmentId': 'string',
            'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
            'roleArn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'controlSetName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- delegations (list) –
  
  The list of delegations that the GetDelegations API returned.
  - (dict) –
    
    The metadata that’s associated with the delegation.
    - id (string) –
      
      The unique identifier for the delegation.
    - assessmentName (string) –
      
      The name of the associated assessment.
    - assessmentId (string) –
      
      The unique identifier for the assessment.
    - status (string) –
      
      The current status of the delegation.
    - roleArn (string) –
      
      The Amazon Resource Name (ARN) of the IAM role.
    - creationTime (datetime) –
      
      Specifies when the delegation was created.
    - controlSetName (string) –
      
      Specifies the name of the control set that was delegated for review.
- nextToken (string) –
  
  The pagination token that’s used to fetch the next set of results.

Exceptions

AuditManager.Client.exceptions.ValidationException
AuditManager.Client.exceptions.AccessDeniedException
AuditManager.Client.exceptions.InternalServerException