EMRContainers / Paginator / ListManagedEndpoints
ListManagedEndpoints#
- class EMRContainers.Paginator.ListManagedEndpoints#
paginator = client.get_paginator('list_managed_endpoints')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
EMRContainers.Client.list_managed_endpoints()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( virtualClusterId='string', createdBefore=datetime(2015, 1, 1), createdAfter=datetime(2015, 1, 1), types=[ 'string', ], states=[ 'CREATING'|'ACTIVE'|'TERMINATING'|'TERMINATED'|'TERMINATED_WITH_ERRORS', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
virtualClusterId (string) –
[REQUIRED]
The ID of the virtual cluster.
createdBefore (datetime) – The date and time before which the endpoints are created.
createdAfter (datetime) – The date and time after which the endpoints are created.
types (list) –
The types of the managed endpoints.
(string) –
states (list) –
The states of the managed endpoints.
(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
{ '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', 'certificateAuthority': { 'certificateArn': 'string', 'certificateData': '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. This field is under deprecation and will be removed in future.
certificateAuthority (dict) –
The certificate generated by emr control plane on customer behalf to secure the managed endpoint.
certificateArn (string) –
The ARN of the certificate generated for managed endpoint.
certificateData (string) –
The base64 encoded PEM certificate data generated for managed 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) –
A token to resume pagination.