EC2 / Paginator / DescribeMacModificationTasks

DescribeMacModificationTasks¶

class EC2.Paginator.DescribeMacModificationTasks¶

paginator = client.get_paginator('describe_mac_modification_tasks')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from EC2.Client.describe_mac_modification_tasks().

Request Syntax

response_iterator = paginator.paginate(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MacModificationTaskIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filters (list) –
Specifies one or more filters for the request:
- instance-id - The ID of the instance for which the task was created.
- task-state - The state of the task ( successful | failed | in-progress | pending).
- mac-system-integrity-protection-configuration.sip-status - The overall SIP state requested in the task ( enabled | disabled).
- start-time - The date and time the task was created.
- task-type - The type of task ( sip-modification | volume-ownership-delegation).
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –
MacModificationTaskIds (list) –
The ID of task.
- (string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'MacModificationTasks': [
        {
            'InstanceId': 'string',
            'MacModificationTaskId': 'string',
            'MacSystemIntegrityProtectionConfig': {
                'AppleInternal': 'enabled'|'disabled',
                'BaseSystem': 'enabled'|'disabled',
                'DebuggingRestrictions': 'enabled'|'disabled',
                'DTraceRestrictions': 'enabled'|'disabled',
                'FilesystemProtections': 'enabled'|'disabled',
                'KextSigning': 'enabled'|'disabled',
                'NvramProtections': 'enabled'|'disabled',
                'Status': 'enabled'|'disabled'
            },
            'StartTime': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'TaskState': 'successful'|'failed'|'in-progress'|'pending',
            'TaskType': 'sip-modification'|'volume-ownership-delegation'
        },
    ],

}

Response Structure

(dict) –
- MacModificationTasks (list) –
  
  Information about the tasks.
  - (dict) –
    
    Information about a System Integrity Protection (SIP) modification task or volume ownership delegation task for an Amazon EC2 Mac instance.
    - InstanceId (string) –
      
      The ID of the Amazon EC2 Mac instance.
    - MacModificationTaskId (string) –
      
      The ID of task.
    - MacSystemIntegrityProtectionConfig (dict) –
      
      [SIP modification tasks only] Information about the SIP configuration.
      - AppleInternal (string) –
        
        Indicates whether Apple Internal was enabled or disabled by the task.
      - BaseSystem (string) –
        
        Indicates whether Base System was enabled or disabled by the task.
      - DebuggingRestrictions (string) –
        
        Indicates whether Debugging Restrictions was enabled or disabled by the task.
      - DTraceRestrictions (string) –
        
        Indicates whether Dtrace Restrictions was enabled or disabled by the task.
      - FilesystemProtections (string) –
        
        Indicates whether Filesystem Protections was enabled or disabled by the task.
      - KextSigning (string) –
        
        Indicates whether Kext Signing was enabled or disabled by the task.
      - NvramProtections (string) –
        
        Indicates whether NVRAM Protections was enabled or disabled by the task.
      - Status (string) –
        
        Indicates SIP was enabled or disabled by the task.
    - StartTime (datetime) –
      
      The date and time the task was created, in the UTC timezone ( YYYY-MM-DDThh:mm:ss.sssZ).
    - Tags (list) –
      
      The tags assigned to the task.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
    - TaskState (string) –
      
      The state of the task.
    - TaskType (string) –
      
      The type of task.