AWS API Changes

2021/07/19 - Amazon EMR Containers - 2 updated api methods

Changes Updated DescribeManagedEndpoint and ListManagedEndpoints to return failureReason and stateDetails in API response.

DescribeManagedEndpoint (updated)

Link ¶
Changes (response)

{'endpoint': {'failureReason': 'INTERNAL_ERROR | USER_ERROR | VALIDATION_ERROR '
                               '| CLUSTER_UNAVAILABLE',
              'stateDetails': 'string'}}

Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

See also: AWS API Documentation

Request Syntax

client.describe_managed_endpoint(
    id='string',
    virtualClusterId='string'
)

type id

string

param id

[REQUIRED]

This output displays ID of the managed endpoint.

type virtualClusterId

string

param virtualClusterId

[REQUIRED]

The ID of the endpoint's virtual cluster.

rtype

dict

returns

Response Syntax

{
    'endpoint': {
        'id': 'string',
        'name': 'string',
        'arn': 'string',
        'virtualClusterId': 'string',
        'type': 'string',
        'state': 'CREATING'|'ACTIVE'|'TERMINATING'|'TERMINATED'|'TERMINATED_WITH_ERRORS',
        'releaseLabel': 'string',
        'executionRoleArn': 'string',
        'certificateArn': 'string',
        'configurationOverrides': {
            'applicationConfiguration': [
                {
                    'classification': 'string',
                    'properties': {
                        'string': 'string'
                    },
                    'configurations': {'... recursive ...'}
                },
            ],
            'monitoringConfiguration': {
                'persistentAppUI': 'ENABLED'|'DISABLED',
                'cloudWatchMonitoringConfiguration': {
                    'logGroupName': 'string',
                    'logStreamNamePrefix': 'string'
                },
                's3MonitoringConfiguration': {
                    'logUri': 'string'
                }
            }
        },
        'serverUrl': 'string',
        'createdAt': datetime(2015, 1, 1),
        'securityGroup': 'string',
        'subnetIds': [
            'string',
        ],
        'stateDetails': 'string',
        'failureReason': 'INTERNAL_ERROR'|'USER_ERROR'|'VALIDATION_ERROR'|'CLUSTER_UNAVAILABLE',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- endpoint (dict) --
  
  This output displays information about a managed endpoint.
  - id (string) --
    
    The ID of the endpoint.
  - name (string) --
    
    The name of the endpoint.
  - arn (string) --
    
    The ARN of the endpoint.
  - virtualClusterId (string) --
    
    The ID of the endpoint's virtual cluster.
  - type (string) --
    
    The type of the endpoint.
  - state (string) --
    
    The state of the endpoint.
  - releaseLabel (string) --
    
    The EMR release version to be used for the endpoint.
  - executionRoleArn (string) --
    
    The execution role ARN of the endpoint.
  - certificateArn (string) --
    
    The certificate ARN of the endpoint.
  - configurationOverrides (dict) --
    
    The configuration settings that are used to override existing configurations for endpoints.
    - applicationConfiguration (list) --
      
      The configurations for the application running by the job run.
      - (dict) --
        
        A configuration specification to be used when provisioning virtual clusters, which can include configurations for applications and software bundled with Amazon EMR on EKS. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.
        
        classification (string) --
        
        The classification within a configuration.
        
        properties (dict) --
        
        A set of properties specified within a configuration classification.
        
        (string) --
        
        (string) --
        
        configurations (list) --
        
        A list of additional configurations to apply within a configuration object.
    - monitoringConfiguration (dict) --
      
      The configurations for monitoring.
      - persistentAppUI (string) --
        
        Monitoring configurations for the persistent application UI.
      - cloudWatchMonitoringConfiguration (dict) --
        
        Monitoring configurations for CloudWatch.
        
        logGroupName (string) --
        
        The name of the log group for log publishing.
        
        logStreamNamePrefix (string) --
        
        The specified name prefix for log streams.
      - s3MonitoringConfiguration (dict) --
        
        Amazon S3 configuration for monitoring log publishing.
        
        logUri (string) --
        
        Amazon S3 destination URI for log publishing.
  - serverUrl (string) --
    
    The server URL of the endpoint.
  - createdAt (datetime) --
    
    The date and time when the endpoint was created.
  - securityGroup (string) --
    
    The security group configuration of the endpoint.
  - subnetIds (list) --
    
    The subnet IDs of the endpoint.
    - (string) --
  - stateDetails (string) --
    
    Additional details of the endpoint state.
  - failureReason (string) --
    
    The reasons why the endpoint has failed.
  - tags (dict) --
    
    The tags of the endpoint.
    - (string) --
      - (string) --

ListManagedEndpoints (updated)

Link ¶
Changes (response)

{'endpoints': {'failureReason': 'INTERNAL_ERROR | USER_ERROR | '
                                'VALIDATION_ERROR | CLUSTER_UNAVAILABLE',
               'stateDetails': 'string'}}

Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

See also: AWS API Documentation

Request Syntax

client.list_managed_endpoints(
    virtualClusterId='string',
    createdBefore=datetime(2015, 1, 1),
    createdAfter=datetime(2015, 1, 1),
    types=[
        'string',
    ],
    states=[
        'CREATING'|'ACTIVE'|'TERMINATING'|'TERMINATED'|'TERMINATED_WITH_ERRORS',
    ],
    maxResults=123,
    nextToken='string'
)

type virtualClusterId

string

param virtualClusterId

[REQUIRED]

The ID of the virtual cluster.

type createdBefore

datetime

param createdBefore

The date and time before which the endpoints are created.

type createdAfter

datetime

param createdAfter

The date and time after which the endpoints are created.

type types

list

param types

The types of the managed endpoints.

(string) --

type states

list

param states

The states of the managed endpoints.

(string) --

type maxResults

integer

param maxResults

The maximum number of managed endpoints that can be listed.

type nextToken

string

param nextToken

The token for the next set of managed endpoints to return.

rtype

dict

returns

Response Syntax

{
    'endpoints': [
        {
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'virtualClusterId': 'string',
            'type': 'string',
            'state': 'CREATING'|'ACTIVE'|'TERMINATING'|'TERMINATED'|'TERMINATED_WITH_ERRORS',
            'releaseLabel': 'string',
            'executionRoleArn': 'string',
            'certificateArn': 'string',
            'configurationOverrides': {
                'applicationConfiguration': [
                    {
                        'classification': 'string',
                        'properties': {
                            'string': 'string'
                        },
                        'configurations': {'... recursive ...'}
                    },
                ],
                'monitoringConfiguration': {
                    'persistentAppUI': 'ENABLED'|'DISABLED',
                    'cloudWatchMonitoringConfiguration': {
                        'logGroupName': 'string',
                        'logStreamNamePrefix': 'string'
                    },
                    's3MonitoringConfiguration': {
                        'logUri': 'string'
                    }
                }
            },
            'serverUrl': 'string',
            'createdAt': datetime(2015, 1, 1),
            'securityGroup': 'string',
            'subnetIds': [
                'string',
            ],
            'stateDetails': 'string',
            'failureReason': 'INTERNAL_ERROR'|'USER_ERROR'|'VALIDATION_ERROR'|'CLUSTER_UNAVAILABLE',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- endpoints (list) --
  
  The managed endpoints to be listed.
  - (dict) --
    
    This entity represents the endpoint that is managed by Amazon EMR on EKS.
    - id (string) --
      
      The ID of the endpoint.
    - name (string) --
      
      The name of the endpoint.
    - arn (string) --
      
      The ARN of the endpoint.
    - virtualClusterId (string) --
      
      The ID of the endpoint's virtual cluster.
    - type (string) --
      
      The type of the endpoint.
    - state (string) --
      
      The state of the endpoint.
    - releaseLabel (string) --
      
      The EMR release version to be used for the endpoint.
    - executionRoleArn (string) --
      
      The execution role ARN of the endpoint.
    - certificateArn (string) --
      
      The certificate ARN of the endpoint.
    - configurationOverrides (dict) --
      
      The configuration settings that are used to override existing configurations for endpoints.
      - applicationConfiguration (list) --
        
        The configurations for the application running by the job run.
        
        (dict) --
        
        A configuration specification to be used when provisioning virtual clusters, which can include configurations for applications and software bundled with Amazon EMR on EKS. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.
        
        classification (string) --
        
        The classification within a configuration.
        
        properties (dict) --
        
        A set of properties specified within a configuration classification.
        
        (string) --
        
        (string) --
        
        configurations (list) --
        
        A list of additional configurations to apply within a configuration object.
      - monitoringConfiguration (dict) --
        
        The configurations for monitoring.
        
        persistentAppUI (string) --
        
        Monitoring configurations for the persistent application UI.
        
        cloudWatchMonitoringConfiguration (dict) --
        
        Monitoring configurations for CloudWatch.
        
        logGroupName (string) --
        
        The name of the log group for log publishing.
        
        logStreamNamePrefix (string) --
        
        The specified name prefix for log streams.
        
        s3MonitoringConfiguration (dict) --
        
        Amazon S3 configuration for monitoring log publishing.
        
        logUri (string) --
        
        Amazon S3 destination URI for log publishing.
    - serverUrl (string) --
      
      The server URL of the endpoint.
    - createdAt (datetime) --
      
      The date and time when the endpoint was created.
    - securityGroup (string) --
      
      The security group configuration of the endpoint.
    - subnetIds (list) --
      
      The subnet IDs of the endpoint.
      - (string) --
    - stateDetails (string) --
      
      Additional details of the endpoint state.
    - failureReason (string) --
      
      The reasons why the endpoint has failed.
    - tags (dict) --
      
      The tags of the endpoint.
      - (string) --
        
        (string) --
- nextToken (string) --
  
  The token for the next set of endpoints to return.