{ "version": "2.0", "metadata": { "apiVersion": "2020-10-01", "endpointPrefix": "emr-containers", "jsonVersion": "1.1", "protocol": "rest-json", "protocols": [ "rest-json" ], "serviceFullName": "Amazon EMR Containers", "serviceId": "EMR containers", "signatureVersion": "v4", "signingName": "emr-containers", "uid": "emr-containers-2020-10-01", "auth": [ "aws.auth#sigv4" ] }, "operations": { "CancelJobRun": { "name": "CancelJobRun", "http": { "method": "DELETE", "requestUri": "/virtualclusters/{virtualClusterId}/jobruns/{jobRunId}" }, "input": { "shape": "CancelJobRunRequest" }, "output": { "shape": "CancelJobRunResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "
Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
" }, "CreateJobTemplate": { "name": "CreateJobTemplate", "http": { "method": "POST", "requestUri": "/jobtemplates" }, "input": { "shape": "CreateJobTemplateRequest" }, "output": { "shape": "CreateJobTemplateResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" } ], "documentation": "Creates a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
" }, "CreateManagedEndpoint": { "name": "CreateManagedEndpoint", "http": { "method": "POST", "requestUri": "/virtualclusters/{virtualClusterId}/endpoints" }, "input": { "shape": "CreateManagedEndpointRequest" }, "output": { "shape": "CreateManagedEndpointResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" } ], "documentation": "Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
" }, "CreateSecurityConfiguration": { "name": "CreateSecurityConfiguration", "http": { "method": "POST", "requestUri": "/securityconfigurations" }, "input": { "shape": "CreateSecurityConfigurationRequest" }, "output": { "shape": "CreateSecurityConfigurationResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "Creates a security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.
" }, "CreateVirtualCluster": { "name": "CreateVirtualCluster", "http": { "method": "POST", "requestUri": "/virtualclusters" }, "input": { "shape": "CreateVirtualClusterRequest" }, "output": { "shape": "CreateVirtualClusterResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" }, { "shape": "EKSRequestThrottledException" } ], "documentation": "Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
" }, "DeleteJobTemplate": { "name": "DeleteJobTemplate", "http": { "method": "DELETE", "requestUri": "/jobtemplates/{templateId}" }, "input": { "shape": "DeleteJobTemplateRequest" }, "output": { "shape": "DeleteJobTemplateResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "Deletes a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
" }, "DeleteManagedEndpoint": { "name": "DeleteManagedEndpoint", "http": { "method": "DELETE", "requestUri": "/virtualclusters/{virtualClusterId}/endpoints/{endpointId}" }, "input": { "shape": "DeleteManagedEndpointRequest" }, "output": { "shape": "DeleteManagedEndpointResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
" }, "DeleteVirtualCluster": { "name": "DeleteVirtualCluster", "http": { "method": "DELETE", "requestUri": "/virtualclusters/{virtualClusterId}" }, "input": { "shape": "DeleteVirtualClusterRequest" }, "output": { "shape": "DeleteVirtualClusterResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
" }, "DescribeJobRun": { "name": "DescribeJobRun", "http": { "method": "GET", "requestUri": "/virtualclusters/{virtualClusterId}/jobruns/{jobRunId}" }, "input": { "shape": "DescribeJobRunRequest" }, "output": { "shape": "DescribeJobRunResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" } ], "documentation": "Displays detailed information about a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
" }, "DescribeJobTemplate": { "name": "DescribeJobTemplate", "http": { "method": "GET", "requestUri": "/jobtemplates/{templateId}" }, "input": { "shape": "DescribeJobTemplateRequest" }, "output": { "shape": "DescribeJobTemplateResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" } ], "documentation": "Displays detailed information about a specified job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
" }, "DescribeManagedEndpoint": { "name": "DescribeManagedEndpoint", "http": { "method": "GET", "requestUri": "/virtualclusters/{virtualClusterId}/endpoints/{endpointId}" }, "input": { "shape": "DescribeManagedEndpointRequest" }, "output": { "shape": "DescribeManagedEndpointResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" } ], "documentation": "Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
" }, "DescribeSecurityConfiguration": { "name": "DescribeSecurityConfiguration", "http": { "method": "GET", "requestUri": "/securityconfigurations/{securityConfigurationId}" }, "input": { "shape": "DescribeSecurityConfigurationRequest" }, "output": { "shape": "DescribeSecurityConfigurationResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" } ], "documentation": "Displays detailed information about a specified security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.
" }, "DescribeVirtualCluster": { "name": "DescribeVirtualCluster", "http": { "method": "GET", "requestUri": "/virtualclusters/{virtualClusterId}" }, "input": { "shape": "DescribeVirtualClusterRequest" }, "output": { "shape": "DescribeVirtualClusterResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" } ], "documentation": "Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
" }, "GetManagedEndpointSessionCredentials": { "name": "GetManagedEndpointSessionCredentials", "http": { "method": "POST", "requestUri": "/virtualclusters/{virtualClusterId}/endpoints/{endpointId}/credentials" }, "input": { "shape": "GetManagedEndpointSessionCredentialsRequest" }, "output": { "shape": "GetManagedEndpointSessionCredentialsResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "RequestThrottledException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" } ], "documentation": "Generate a session token to connect to a managed endpoint.
" }, "ListJobRuns": { "name": "ListJobRuns", "http": { "method": "GET", "requestUri": "/virtualclusters/{virtualClusterId}/jobruns" }, "input": { "shape": "ListJobRunsRequest" }, "output": { "shape": "ListJobRunsResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "Lists job runs based on a set of parameters. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
" }, "ListJobTemplates": { "name": "ListJobTemplates", "http": { "method": "GET", "requestUri": "/jobtemplates" }, "input": { "shape": "ListJobTemplatesRequest" }, "output": { "shape": "ListJobTemplatesResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "Lists job templates based on a set of parameters. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
" }, "ListManagedEndpoints": { "name": "ListManagedEndpoints", "http": { "method": "GET", "requestUri": "/virtualclusters/{virtualClusterId}/endpoints" }, "input": { "shape": "ListManagedEndpointsRequest" }, "output": { "shape": "ListManagedEndpointsResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
" }, "ListSecurityConfigurations": { "name": "ListSecurityConfigurations", "http": { "method": "GET", "requestUri": "/securityconfigurations" }, "input": { "shape": "ListSecurityConfigurationsRequest" }, "output": { "shape": "ListSecurityConfigurationsResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "Lists security configurations based on a set of parameters. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.
" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "GET", "requestUri": "/tags/{resourceArn}" }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Lists the tags assigned to the resources.
" }, "ListVirtualClusters": { "name": "ListVirtualClusters", "http": { "method": "GET", "requestUri": "/virtualclusters" }, "input": { "shape": "ListVirtualClustersRequest" }, "output": { "shape": "ListVirtualClustersResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "InternalServerException" } ], "documentation": "Lists information about the specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
" }, "StartJobRun": { "name": "StartJobRun", "http": { "method": "POST", "requestUri": "/virtualclusters/{virtualClusterId}/jobruns" }, "input": { "shape": "StartJobRunRequest" }, "output": { "shape": "StartJobRunResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" } ], "documentation": "Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/tags/{resourceArn}" }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your Amazon Web Services resources by attributes such as purpose, owner, or environment. When you have many resources of the same type, you can quickly identify a specific resource based on the tags you've assigned to it. For example, you can define a set of tags for your Amazon EMR on EKS clusters to help you track each cluster's owner and stack level. We recommend that you devise a consistent set of tag keys for each resource type. You can then search and filter the resources based on the tags that you add.
" }, "UntagResource": { "name": "UntagResource", "http": { "method": "DELETE", "requestUri": "/tags/{resourceArn}" }, "input": { "shape": "UntagResourceRequest" }, "output": { "shape": "UntagResourceResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Removes tags from resources.
" } }, "shapes": { "ACMCertArn": { "type": "string", "max": 2048, "min": 44, "pattern": "^arn:(aws[a-zA-Z0-9-]*):acm:.+:(\\d{12}):certificate/.+$" }, "AuthorizationConfiguration": { "type": "structure", "members": { "lakeFormationConfiguration": { "shape": "LakeFormationConfiguration", "documentation": "Lake Formation related configuration inputs for the security configuration.
" }, "encryptionConfiguration": { "shape": "EncryptionConfiguration", "documentation": "Encryption-related configuration input for the security configuration.
" } }, "documentation": "Authorization-related configuration inputs for the security configuration.
" }, "Base64Encoded": { "type": "string", "max": 5000, "pattern": "^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$" }, "Boolean": { "type": "boolean" }, "CancelJobRunRequest": { "type": "structure", "required": [ "id", "virtualClusterId" ], "members": { "id": { "shape": "ResourceIdString", "documentation": "The ID of the job run to cancel.
", "location": "uri", "locationName": "jobRunId" }, "virtualClusterId": { "shape": "ResourceIdString", "documentation": "The ID of the virtual cluster for which the job run will be canceled.
", "location": "uri", "locationName": "virtualClusterId" } } }, "CancelJobRunResponse": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "The output contains the ID of the cancelled job run.
" }, "virtualClusterId": { "shape": "ResourceIdString", "documentation": "The output contains the virtual cluster ID for which the job run is cancelled.
" } } }, "Certificate": { "type": "structure", "members": { "certificateArn": { "shape": "ACMCertArn", "documentation": "The ARN of the certificate generated for managed endpoint.
" }, "certificateData": { "shape": "Base64Encoded", "documentation": "The base64 encoded PEM certificate data generated for managed endpoint.
" } }, "documentation": "The entity representing certificate data generated for managed endpoint.
" }, "CertificateProviderType": { "type": "string", "enum": [ "PEM" ] }, "ClientToken": { "type": "string", "max": 64, "min": 1, "pattern": ".*\\S.*" }, "CloudWatchMonitoringConfiguration": { "type": "structure", "required": [ "logGroupName" ], "members": { "logGroupName": { "shape": "LogGroupName", "documentation": "The name of the log group for log publishing.
" }, "logStreamNamePrefix": { "shape": "String256", "documentation": "The specified name prefix for log streams.
" } }, "documentation": "A configuration for CloudWatch monitoring. You can configure your jobs to send log information to CloudWatch Logs.
" }, "ClusterId": { "type": "string", "max": 100, "min": 1, "pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*" }, "Configuration": { "type": "structure", "required": [ "classification" ], "members": { "classification": { "shape": "String1024", "documentation": "The classification within a configuration.
" }, "properties": { "shape": "SensitivePropertiesMap", "documentation": "A set of properties specified within a configuration classification.
" }, "configurations": { "shape": "ConfigurationList", "documentation": "A list of additional configurations to apply within a configuration object.
" } }, "documentation": "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.
" }, "ConfigurationList": { "type": "list", "member": { "shape": "Configuration" }, "max": 100 }, "ConfigurationOverrides": { "type": "structure", "members": { "applicationConfiguration": { "shape": "ConfigurationList", "documentation": "The configurations for the application running by the job run.
" }, "monitoringConfiguration": { "shape": "MonitoringConfiguration", "documentation": "The configurations for monitoring.
" } }, "documentation": "A configuration specification to be used to override existing configurations.
" }, "ContainerInfo": { "type": "structure", "members": { "eksInfo": { "shape": "EksInfo", "documentation": "The information about the Amazon EKS cluster.
" } }, "documentation": "The information about the container used for a job run or a managed endpoint.
", "union": true }, "ContainerLogRotationConfiguration": { "type": "structure", "required": [ "rotationSize", "maxFilesToKeep" ], "members": { "rotationSize": { "shape": "RotationSize", "documentation": "The file size at which to rotate logs. Minimum of 2KB, Maximum of 2GB.
" }, "maxFilesToKeep": { "shape": "MaxFilesToKeep", "documentation": "The number of files to keep in container after rotation.
" } }, "documentation": "The settings for container log rotation.
" }, "ContainerProvider": { "type": "structure", "required": [ "type", "id" ], "members": { "type": { "shape": "ContainerProviderType", "documentation": "The type of the container provider. Amazon EKS is the only supported type as of now.
" }, "id": { "shape": "ClusterId", "documentation": "The ID of the container cluster.
" }, "info": { "shape": "ContainerInfo", "documentation": "The information about the container cluster.
" } }, "documentation": "The information about the container provider.
" }, "ContainerProviderType": { "type": "string", "enum": [ "EKS" ] }, "CreateJobTemplateRequest": { "type": "structure", "required": [ "name", "clientToken", "jobTemplateData" ], "members": { "name": { "shape": "ResourceNameString", "documentation": "The specified name of the job template.
" }, "clientToken": { "shape": "ClientToken", "documentation": "The client token of the job template.
", "idempotencyToken": true }, "jobTemplateData": { "shape": "JobTemplateData", "documentation": "The job template data which holds values of StartJobRun API request.
" }, "tags": { "shape": "TagMap", "documentation": "The tags that are associated with the job template.
" }, "kmsKeyArn": { "shape": "KmsKeyArn", "documentation": "The KMS key ARN used to encrypt the job template.
" } } }, "CreateJobTemplateResponse": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "This output display the created job template ID.
" }, "name": { "shape": "ResourceNameString", "documentation": "This output displays the name of the created job template.
" }, "arn": { "shape": "JobTemplateArn", "documentation": "This output display the ARN of the created job template.
" }, "createdAt": { "shape": "Date", "documentation": "This output displays the date and time when the job template was created.
" } } }, "CreateManagedEndpointRequest": { "type": "structure", "required": [ "name", "virtualClusterId", "type", "releaseLabel", "executionRoleArn", "clientToken" ], "members": { "name": { "shape": "ResourceNameString", "documentation": "The name of the managed endpoint.
" }, "virtualClusterId": { "shape": "ResourceIdString", "documentation": "The ID of the virtual cluster for which a managed endpoint is created.
", "location": "uri", "locationName": "virtualClusterId" }, "type": { "shape": "EndpointType", "documentation": "The type of the managed endpoint.
" }, "releaseLabel": { "shape": "ReleaseLabel", "documentation": "The Amazon EMR release version.
" }, "executionRoleArn": { "shape": "IAMRoleArn", "documentation": "The ARN of the execution role.
" }, "certificateArn": { "shape": "ACMCertArn", "documentation": "The certificate ARN provided by users for the managed endpoint. This field is under deprecation and will be removed in future releases.
", "deprecated": true, "deprecatedMessage": "Customer provided certificate-arn is deprecated and would be removed in future." }, "configurationOverrides": { "shape": "ConfigurationOverrides", "documentation": "The configuration settings that will be used to override existing configurations.
" }, "clientToken": { "shape": "ClientToken", "documentation": "The client idempotency token for this create call.
", "idempotencyToken": true }, "tags": { "shape": "TagMap", "documentation": "The tags of the managed endpoint.
" } } }, "CreateManagedEndpointResponse": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "The output contains the ID of the managed endpoint.
" }, "name": { "shape": "ResourceNameString", "documentation": "The output contains the name of the managed endpoint.
" }, "arn": { "shape": "EndpointArn", "documentation": "The output contains the ARN of the managed endpoint.
" }, "virtualClusterId": { "shape": "ResourceIdString", "documentation": "The output contains the ID of the virtual cluster.
" } } }, "CreateSecurityConfigurationRequest": { "type": "structure", "required": [ "clientToken", "name", "securityConfigurationData" ], "members": { "clientToken": { "shape": "ClientToken", "documentation": "The client idempotency token to use when creating the security configuration.
", "idempotencyToken": true }, "name": { "shape": "ResourceNameString", "documentation": "The name of the security configuration.
" }, "securityConfigurationData": { "shape": "SecurityConfigurationData", "documentation": "Security configuration input for the request.
" }, "tags": { "shape": "TagMap", "documentation": "The tags to add to the security configuration.
" } } }, "CreateSecurityConfigurationResponse": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "The ID of the security configuration.
" }, "name": { "shape": "ResourceNameString", "documentation": "The name of the security configuration.
" }, "arn": { "shape": "SecurityConfigurationArn", "documentation": "The ARN (Amazon Resource Name) of the security configuration.
" } } }, "CreateVirtualClusterRequest": { "type": "structure", "required": [ "name", "containerProvider", "clientToken" ], "members": { "name": { "shape": "ResourceNameString", "documentation": "The specified name of the virtual cluster.
" }, "containerProvider": { "shape": "ContainerProvider", "documentation": "The container provider of the virtual cluster.
" }, "clientToken": { "shape": "ClientToken", "documentation": "The client token of the virtual cluster.
", "idempotencyToken": true }, "tags": { "shape": "TagMap", "documentation": "The tags assigned to the virtual cluster.
" }, "securityConfigurationId": { "shape": "ResourceIdString", "documentation": "The ID of the security configuration.
" } } }, "CreateVirtualClusterResponse": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "This output contains the virtual cluster ID.
" }, "name": { "shape": "ResourceNameString", "documentation": "This output contains the name of the virtual cluster.
" }, "arn": { "shape": "VirtualClusterArn", "documentation": "This output contains the ARN of virtual cluster.
" } } }, "CredentialType": { "type": "string", "max": 64, "min": 1, "pattern": "^.*\\S.*$" }, "Credentials": { "type": "structure", "members": { "token": { "shape": "Token", "documentation": "The actual session token being returned.
" } }, "documentation": "The structure containing the session token being returned.
", "union": true }, "Date": { "type": "timestamp", "timestampFormat": "iso8601" }, "DeleteJobTemplateRequest": { "type": "structure", "required": [ "id" ], "members": { "id": { "shape": "ResourceIdString", "documentation": "The ID of the job template that will be deleted.
", "location": "uri", "locationName": "templateId" } } }, "DeleteJobTemplateResponse": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "This output contains the ID of the job template that was deleted.
" } } }, "DeleteManagedEndpointRequest": { "type": "structure", "required": [ "id", "virtualClusterId" ], "members": { "id": { "shape": "ResourceIdString", "documentation": "The ID of the managed endpoint.
", "location": "uri", "locationName": "endpointId" }, "virtualClusterId": { "shape": "ResourceIdString", "documentation": "The ID of the endpoint's virtual cluster.
", "location": "uri", "locationName": "virtualClusterId" } } }, "DeleteManagedEndpointResponse": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "The output displays the ID of the managed endpoint.
" }, "virtualClusterId": { "shape": "ResourceIdString", "documentation": "The output displays the ID of the endpoint's virtual cluster.
" } } }, "DeleteVirtualClusterRequest": { "type": "structure", "required": [ "id" ], "members": { "id": { "shape": "ResourceIdString", "documentation": "The ID of the virtual cluster that will be deleted.
", "location": "uri", "locationName": "virtualClusterId" } } }, "DeleteVirtualClusterResponse": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "This output contains the ID of the virtual cluster that will be deleted.
" } } }, "DescribeJobRunRequest": { "type": "structure", "required": [ "id", "virtualClusterId" ], "members": { "id": { "shape": "ResourceIdString", "documentation": "The ID of the job run request.
", "location": "uri", "locationName": "jobRunId" }, "virtualClusterId": { "shape": "ResourceIdString", "documentation": "The ID of the virtual cluster for which the job run is submitted.
", "location": "uri", "locationName": "virtualClusterId" } } }, "DescribeJobRunResponse": { "type": "structure", "members": { "jobRun": { "shape": "JobRun", "documentation": "The output displays information about a job run.
" } } }, "DescribeJobTemplateRequest": { "type": "structure", "required": [ "id" ], "members": { "id": { "shape": "ResourceIdString", "documentation": "The ID of the job template that will be described.
", "location": "uri", "locationName": "templateId" } } }, "DescribeJobTemplateResponse": { "type": "structure", "members": { "jobTemplate": { "shape": "JobTemplate", "documentation": "This output displays information about the specified job template.
" } } }, "DescribeManagedEndpointRequest": { "type": "structure", "required": [ "id", "virtualClusterId" ], "members": { "id": { "shape": "ResourceIdString", "documentation": "This output displays ID of the managed endpoint.
", "location": "uri", "locationName": "endpointId" }, "virtualClusterId": { "shape": "ResourceIdString", "documentation": "The ID of the endpoint's virtual cluster.
", "location": "uri", "locationName": "virtualClusterId" } } }, "DescribeManagedEndpointResponse": { "type": "structure", "members": { "endpoint": { "shape": "Endpoint", "documentation": "This output displays information about a managed endpoint.
" } } }, "DescribeSecurityConfigurationRequest": { "type": "structure", "required": [ "id" ], "members": { "id": { "shape": "ResourceIdString", "documentation": "The ID of the security configuration.
", "location": "uri", "locationName": "securityConfigurationId" } } }, "DescribeSecurityConfigurationResponse": { "type": "structure", "members": { "securityConfiguration": { "shape": "SecurityConfiguration", "documentation": "Details of the security configuration.
" } } }, "DescribeVirtualClusterRequest": { "type": "structure", "required": [ "id" ], "members": { "id": { "shape": "ResourceIdString", "documentation": "The ID of the virtual cluster that will be described.
", "location": "uri", "locationName": "virtualClusterId" } } }, "DescribeVirtualClusterResponse": { "type": "structure", "members": { "virtualCluster": { "shape": "VirtualCluster", "documentation": "This output displays information about the specified virtual cluster.
" } } }, "EksInfo": { "type": "structure", "members": { "namespace": { "shape": "KubernetesNamespace", "documentation": "The namespaces of the Amazon EKS cluster.
" } }, "documentation": "The information about the Amazon EKS cluster.
" }, "EncryptionConfiguration": { "type": "structure", "members": { "inTransitEncryptionConfiguration": { "shape": "InTransitEncryptionConfiguration", "documentation": "In-transit encryption-related input for the security configuration.
" } }, "documentation": "Configurations related to encryption for the security configuration.
" }, "Endpoint": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "The ID of the endpoint.
" }, "name": { "shape": "ResourceNameString", "documentation": "The name of the endpoint.
" }, "arn": { "shape": "EndpointArn", "documentation": "The ARN of the endpoint.
" }, "virtualClusterId": { "shape": "ResourceIdString", "documentation": "The ID of the endpoint's virtual cluster.
" }, "type": { "shape": "EndpointType", "documentation": "The type of the endpoint.
" }, "state": { "shape": "EndpointState", "documentation": "The state of the endpoint.
" }, "releaseLabel": { "shape": "ReleaseLabel", "documentation": "The EMR release version to be used for the endpoint.
" }, "executionRoleArn": { "shape": "IAMRoleArn", "documentation": "The execution role ARN of the endpoint.
" }, "certificateArn": { "shape": "ACMCertArn", "documentation": "The certificate ARN of the endpoint. This field is under deprecation and will be removed in future.
", "deprecated": true, "deprecatedMessage": "Customer provided certificate-arn is deprecated and would be removed in future." }, "certificateAuthority": { "shape": "Certificate", "documentation": "The certificate generated by emr control plane on customer behalf to secure the managed endpoint.
" }, "configurationOverrides": { "shape": "ConfigurationOverrides", "documentation": "The configuration settings that are used to override existing configurations for endpoints.
" }, "serverUrl": { "shape": "UriString", "documentation": "The server URL of the endpoint.
" }, "createdAt": { "shape": "Date", "documentation": "The date and time when the endpoint was created.
" }, "securityGroup": { "shape": "String256", "documentation": "The security group configuration of the endpoint.
" }, "subnetIds": { "shape": "SubnetIds", "documentation": "The subnet IDs of the endpoint.
" }, "stateDetails": { "shape": "String256", "documentation": "Additional details of the endpoint state.
" }, "failureReason": { "shape": "FailureReason", "documentation": "The reasons why the endpoint has failed.
" }, "tags": { "shape": "TagMap", "documentation": "The tags of the endpoint.
" } }, "documentation": "This entity represents the endpoint that is managed by Amazon EMR on EKS.
" }, "EndpointArn": { "type": "string", "max": 1024, "min": 60, "pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+\\/endpoints\\/[0-9a-zA-Z]+$" }, "EndpointState": { "type": "string", "enum": [ "CREATING", "ACTIVE", "TERMINATING", "TERMINATED", "TERMINATED_WITH_ERRORS" ] }, "EndpointStates": { "type": "list", "member": { "shape": "EndpointState" }, "max": 10 }, "EndpointType": { "type": "string", "max": 64, "min": 1, "pattern": ".*\\S.*" }, "EndpointTypes": { "type": "list", "member": { "shape": "EndpointType" }, "max": 10 }, "Endpoints": { "type": "list", "member": { "shape": "Endpoint" } }, "EntryPointArgument": { "type": "string", "max": 10280, "min": 1, "pattern": ".*\\S.*", "sensitive": true }, "EntryPointArguments": { "type": "list", "member": { "shape": "EntryPointArgument" } }, "EntryPointPath": { "type": "string", "max": 256, "min": 1, "pattern": ".*\\S.*", "sensitive": true }, "FailureReason": { "type": "string", "enum": [ "INTERNAL_ERROR", "USER_ERROR", "VALIDATION_ERROR", "CLUSTER_UNAVAILABLE" ] }, "GetManagedEndpointSessionCredentialsRequest": { "type": "structure", "required": [ "executionRoleArn", "credentialType", "endpointIdentifier", "virtualClusterIdentifier" ], "members": { "endpointIdentifier": { "shape": "String2048", "documentation": "The ARN of the managed endpoint for which the request is submitted.
", "location": "uri", "locationName": "endpointId" }, "virtualClusterIdentifier": { "shape": "String2048", "documentation": "The ARN of the Virtual Cluster which the Managed Endpoint belongs to.
", "location": "uri", "locationName": "virtualClusterId" }, "executionRoleArn": { "shape": "IAMRoleArn", "documentation": "The IAM Execution Role ARN that will be used by the job run.
" }, "credentialType": { "shape": "CredentialType", "documentation": "Type of the token requested. Currently supported and default value of this field is “TOKEN.”
" }, "durationInSeconds": { "shape": "JavaInteger", "documentation": "Duration in seconds for which the session token is valid. The default duration is 15 minutes and the maximum is 12 hours.
" }, "logContext": { "shape": "LogContext", "documentation": "String identifier used to separate sections of the execution logs uploaded to S3.
" }, "clientToken": { "shape": "ClientToken", "documentation": "The client idempotency token of the job run request.
", "idempotencyToken": true } } }, "GetManagedEndpointSessionCredentialsResponse": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "The identifier of the session token returned.
" }, "credentials": { "shape": "Credentials", "documentation": "The structure containing the session credentials.
" }, "expiresAt": { "shape": "Date", "documentation": "The date and time when the session token will expire.
" } } }, "IAMRoleArn": { "type": "string", "max": 2048, "min": 20, "pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" }, "InTransitEncryptionConfiguration": { "type": "structure", "members": { "tlsCertificateConfiguration": { "shape": "TLSCertificateConfiguration", "documentation": "TLS certificate-related configuration input for the security configuration.
" } }, "documentation": "Configurations related to in-transit encryption for the security configuration.
" }, "JavaInteger": { "type": "integer" }, "JobArn": { "type": "string", "max": 1024, "min": 60, "pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+\\/jobruns\\/[0-9a-zA-Z]+$" }, "JobDriver": { "type": "structure", "members": { "sparkSubmitJobDriver": { "shape": "SparkSubmitJobDriver", "documentation": "The job driver parameters specified for spark submit.
" }, "sparkSqlJobDriver": { "shape": "SparkSqlJobDriver", "documentation": "The job driver for job type.
" } }, "documentation": "Specify the driver that the job runs on. Exactly one of the two available job drivers is required, either sparkSqlJobDriver or sparkSubmitJobDriver.
" }, "JobRun": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "The ID of the job run.
" }, "name": { "shape": "ResourceNameString", "documentation": "The name of the job run.
" }, "virtualClusterId": { "shape": "ResourceIdString", "documentation": "The ID of the job run's virtual cluster.
" }, "arn": { "shape": "JobArn", "documentation": "The ARN of job run.
" }, "state": { "shape": "JobRunState", "documentation": "The state of the job run.
" }, "clientToken": { "shape": "ClientToken", "documentation": "The client token used to start a job run.
" }, "executionRoleArn": { "shape": "IAMRoleArn", "documentation": "The execution role ARN of the job run.
" }, "releaseLabel": { "shape": "ReleaseLabel", "documentation": "The release version of Amazon EMR.
" }, "configurationOverrides": { "shape": "ConfigurationOverrides", "documentation": "The configuration settings that are used to override default configuration.
" }, "jobDriver": { "shape": "JobDriver", "documentation": "Parameters of job driver for the job run.
" }, "createdAt": { "shape": "Date", "documentation": "The date and time when the job run was created.
" }, "createdBy": { "shape": "RequestIdentityUserArn", "documentation": "The user who created the job run.
" }, "finishedAt": { "shape": "Date", "documentation": "The date and time when the job run has finished.
" }, "stateDetails": { "shape": "String256", "documentation": "Additional details of the job run state.
" }, "failureReason": { "shape": "FailureReason", "documentation": "The reasons why the job run has failed.
" }, "tags": { "shape": "TagMap", "documentation": "The assigned tags of the job run.
" }, "retryPolicyConfiguration": { "shape": "RetryPolicyConfiguration", "documentation": "The configuration of the retry policy that the job runs on.
" }, "retryPolicyExecution": { "shape": "RetryPolicyExecution", "documentation": "The current status of the retry policy executed on the job.
" } }, "documentation": "This entity describes a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
" }, "JobRunState": { "type": "string", "enum": [ "PENDING", "SUBMITTED", "RUNNING", "FAILED", "CANCELLED", "CANCEL_PENDING", "COMPLETED" ] }, "JobRunStates": { "type": "list", "member": { "shape": "JobRunState" }, "max": 10 }, "JobRuns": { "type": "list", "member": { "shape": "JobRun" } }, "JobTemplate": { "type": "structure", "required": [ "jobTemplateData" ], "members": { "name": { "shape": "ResourceNameString", "documentation": "The name of the job template.
" }, "id": { "shape": "ResourceIdString", "documentation": "The ID of the job template.
" }, "arn": { "shape": "JobTemplateArn", "documentation": "The ARN of the job template.
" }, "createdAt": { "shape": "Date", "documentation": "The date and time when the job template was created.
" }, "createdBy": { "shape": "RequestIdentityUserArn", "documentation": "The user who created the job template.
" }, "tags": { "shape": "TagMap", "documentation": "The tags assigned to the job template.
" }, "jobTemplateData": { "shape": "JobTemplateData", "documentation": "The job template data which holds values of StartJobRun API request.
" }, "kmsKeyArn": { "shape": "KmsKeyArn", "documentation": "The KMS key ARN used to encrypt the job template.
" }, "decryptionError": { "shape": "String2048", "documentation": "The error message in case the decryption of job template fails.
" } }, "documentation": "This entity describes a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
" }, "JobTemplateArn": { "type": "string", "max": 1024, "min": 60, "pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/jobtemplates\\/[0-9a-zA-Z]+$" }, "JobTemplateData": { "type": "structure", "required": [ "executionRoleArn", "releaseLabel", "jobDriver" ], "members": { "executionRoleArn": { "shape": "ParametricIAMRoleArn", "documentation": "The execution role ARN of the job run.
" }, "releaseLabel": { "shape": "ParametricReleaseLabel", "documentation": "The release version of Amazon EMR.
" }, "configurationOverrides": { "shape": "ParametricConfigurationOverrides", "documentation": "The configuration settings that are used to override defaults configuration.
" }, "jobDriver": { "shape": "JobDriver" }, "parameterConfiguration": { "shape": "TemplateParameterConfigurationMap", "documentation": "The configuration of parameters existing in the job template.
" }, "jobTags": { "shape": "TagMap", "documentation": "The tags assigned to jobs started using the job template.
" } }, "documentation": "The values of StartJobRun API requests used in job runs started using the job template.
" }, "JobTemplates": { "type": "list", "member": { "shape": "JobTemplate" } }, "KmsKeyArn": { "type": "string", "max": 2048, "min": 3, "pattern": "^(arn:(aws[a-zA-Z0-9-]*):kms:.+:(\\d{12})?:key\\/[(0-9a-zA-Z)-?]+|\\$\\{[a-zA-Z]\\w*\\})$" }, "KubernetesNamespace": { "type": "string", "max": 63, "min": 1, "pattern": "[a-z0-9]([-a-z0-9]*[a-z0-9])?" }, "LakeFormationConfiguration": { "type": "structure", "members": { "authorizedSessionTagValue": { "shape": "SessionTagValue", "documentation": "The session tag to authorize Amazon EMR on EKS for API calls to Lake Formation.
" }, "secureNamespaceInfo": { "shape": "SecureNamespaceInfo", "documentation": "The namespace input of the system job.
" }, "queryEngineRoleArn": { "shape": "IAMRoleArn", "documentation": "The query engine IAM role ARN that is tied to the secure Spark job. The QueryEngine
role assumes the JobExecutionRole
to execute all the Lake Formation calls.
Lake Formation related configuration inputs for the security configuration.
" }, "ListJobRunsRequest": { "type": "structure", "required": [ "virtualClusterId" ], "members": { "virtualClusterId": { "shape": "ResourceIdString", "documentation": "The ID of the virtual cluster for which to list the job run.
", "location": "uri", "locationName": "virtualClusterId" }, "createdBefore": { "shape": "Date", "documentation": "The date and time before which the job runs were submitted.
", "location": "querystring", "locationName": "createdBefore" }, "createdAfter": { "shape": "Date", "documentation": "The date and time after which the job runs were submitted.
", "location": "querystring", "locationName": "createdAfter" }, "name": { "shape": "ResourceNameString", "documentation": "The name of the job run.
", "location": "querystring", "locationName": "name" }, "states": { "shape": "JobRunStates", "documentation": "The states of the job run.
", "location": "querystring", "locationName": "states" }, "maxResults": { "shape": "JavaInteger", "documentation": "The maximum number of job runs that can be listed.
", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "NextToken", "documentation": "The token for the next set of job runs to return.
", "location": "querystring", "locationName": "nextToken" } } }, "ListJobRunsResponse": { "type": "structure", "members": { "jobRuns": { "shape": "JobRuns", "documentation": "This output lists information about the specified job runs.
" }, "nextToken": { "shape": "NextToken", "documentation": "This output displays the token for the next set of job runs.
" } } }, "ListJobTemplatesRequest": { "type": "structure", "members": { "createdAfter": { "shape": "Date", "documentation": "The date and time after which the job templates were created.
", "location": "querystring", "locationName": "createdAfter" }, "createdBefore": { "shape": "Date", "documentation": "The date and time before which the job templates were created.
", "location": "querystring", "locationName": "createdBefore" }, "maxResults": { "shape": "JavaInteger", "documentation": "The maximum number of job templates that can be listed.
", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "NextToken", "documentation": "The token for the next set of job templates to return.
", "location": "querystring", "locationName": "nextToken" } } }, "ListJobTemplatesResponse": { "type": "structure", "members": { "templates": { "shape": "JobTemplates", "documentation": "This output lists information about the specified job templates.
" }, "nextToken": { "shape": "NextToken", "documentation": "This output displays the token for the next set of job templates.
" } } }, "ListManagedEndpointsRequest": { "type": "structure", "required": [ "virtualClusterId" ], "members": { "virtualClusterId": { "shape": "ResourceIdString", "documentation": "The ID of the virtual cluster.
", "location": "uri", "locationName": "virtualClusterId" }, "createdBefore": { "shape": "Date", "documentation": "The date and time before which the endpoints are created.
", "location": "querystring", "locationName": "createdBefore" }, "createdAfter": { "shape": "Date", "documentation": "The date and time after which the endpoints are created.
", "location": "querystring", "locationName": "createdAfter" }, "types": { "shape": "EndpointTypes", "documentation": "The types of the managed endpoints.
", "location": "querystring", "locationName": "types" }, "states": { "shape": "EndpointStates", "documentation": "The states of the managed endpoints.
", "location": "querystring", "locationName": "states" }, "maxResults": { "shape": "JavaInteger", "documentation": "The maximum number of managed endpoints that can be listed.
", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "NextToken", "documentation": "The token for the next set of managed endpoints to return.
", "location": "querystring", "locationName": "nextToken" } } }, "ListManagedEndpointsResponse": { "type": "structure", "members": { "endpoints": { "shape": "Endpoints", "documentation": "The managed endpoints to be listed.
" }, "nextToken": { "shape": "NextToken", "documentation": "The token for the next set of endpoints to return.
" } } }, "ListSecurityConfigurationsRequest": { "type": "structure", "members": { "createdAfter": { "shape": "Date", "documentation": "The date and time after which the security configuration was created.
", "location": "querystring", "locationName": "createdAfter" }, "createdBefore": { "shape": "Date", "documentation": "The date and time before which the security configuration was created.
", "location": "querystring", "locationName": "createdBefore" }, "maxResults": { "shape": "JavaInteger", "documentation": "The maximum number of security configurations the operation can list.
", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "NextToken", "documentation": "The token for the next set of security configurations to return.
", "location": "querystring", "locationName": "nextToken" } } }, "ListSecurityConfigurationsResponse": { "type": "structure", "members": { "securityConfigurations": { "shape": "SecurityConfigurations", "documentation": "The list of returned security configurations.
" }, "nextToken": { "shape": "NextToken", "documentation": "The token for the next set of security configurations to return.
" } } }, "ListTagsForResourceRequest": { "type": "structure", "required": [ "resourceArn" ], "members": { "resourceArn": { "shape": "RsiArn", "documentation": "The ARN of tagged resources.
", "location": "uri", "locationName": "resourceArn" } } }, "ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "shape": "TagMap", "documentation": "The tags assigned to resources.
" } } }, "ListVirtualClustersRequest": { "type": "structure", "members": { "containerProviderId": { "shape": "String1024", "documentation": "The container provider ID of the virtual cluster.
", "location": "querystring", "locationName": "containerProviderId" }, "containerProviderType": { "shape": "ContainerProviderType", "documentation": "The container provider type of the virtual cluster. Amazon EKS is the only supported type as of now.
", "location": "querystring", "locationName": "containerProviderType" }, "createdAfter": { "shape": "Date", "documentation": "The date and time after which the virtual clusters are created.
", "location": "querystring", "locationName": "createdAfter" }, "createdBefore": { "shape": "Date", "documentation": "The date and time before which the virtual clusters are created.
", "location": "querystring", "locationName": "createdBefore" }, "states": { "shape": "VirtualClusterStates", "documentation": "The states of the requested virtual clusters.
", "location": "querystring", "locationName": "states" }, "maxResults": { "shape": "JavaInteger", "documentation": "The maximum number of virtual clusters that can be listed.
", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "NextToken", "documentation": "The token for the next set of virtual clusters to return.
", "location": "querystring", "locationName": "nextToken" }, "eksAccessEntryIntegrated": { "shape": "Boolean", "documentation": "Optional Boolean that specifies whether the operation should return the virtual clusters that have the access entry integration enabled or disabled. If not specified, the operation returns all applicable virtual clusters.
", "location": "querystring", "locationName": "eksAccessEntryIntegrated" } } }, "ListVirtualClustersResponse": { "type": "structure", "members": { "virtualClusters": { "shape": "VirtualClusters", "documentation": "This output lists the specified virtual clusters.
" }, "nextToken": { "shape": "NextToken", "documentation": "This output displays the token for the next set of virtual clusters.
" } } }, "LogContext": { "type": "string", "max": 63, "min": 3, "pattern": "^((?!.*-s3alias)(?!xn--.*)[a-z0-9][-a-z0-9.]*)?[a-z0-9]$" }, "LogGroupName": { "type": "string", "max": 512, "min": 1, "pattern": "[\\.\\-_/#A-Za-z0-9]+" }, "MaxFilesToKeep": { "type": "integer", "max": 50, "min": 1 }, "MonitoringConfiguration": { "type": "structure", "members": { "persistentAppUI": { "shape": "PersistentAppUI", "documentation": "Monitoring configurations for the persistent application UI.
" }, "cloudWatchMonitoringConfiguration": { "shape": "CloudWatchMonitoringConfiguration", "documentation": "Monitoring configurations for CloudWatch.
" }, "s3MonitoringConfiguration": { "shape": "S3MonitoringConfiguration", "documentation": "Amazon S3 configuration for monitoring log publishing.
" }, "containerLogRotationConfiguration": { "shape": "ContainerLogRotationConfiguration", "documentation": "Enable or disable container log rotation.
" } }, "documentation": "Configuration setting for monitoring.
" }, "NextToken": { "type": "string", "max": 1024, "min": 1, "pattern": ".*\\S.*" }, "ParametricCloudWatchMonitoringConfiguration": { "type": "structure", "members": { "logGroupName": { "shape": "TemplateParameter", "documentation": "The name of the log group for log publishing.
" }, "logStreamNamePrefix": { "shape": "String256", "documentation": "The specified name prefix for log streams.
" } }, "documentation": "A configuration for CloudWatch monitoring. You can configure your jobs to send log information to CloudWatch Logs. This data type allows job template parameters to be specified within.
" }, "ParametricConfigurationOverrides": { "type": "structure", "members": { "applicationConfiguration": { "shape": "ConfigurationList", "documentation": "The configurations for the application running by the job run.
" }, "monitoringConfiguration": { "shape": "ParametricMonitoringConfiguration", "documentation": "The configurations for monitoring.
" } }, "documentation": "A configuration specification to be used to override existing configurations. This data type allows job template parameters to be specified within.
" }, "ParametricIAMRoleArn": { "type": "string", "max": 2048, "min": 4, "pattern": "(^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$)|([\\.\\-_\\#A-Za-z0-9\\$\\{\\}]+)" }, "ParametricMonitoringConfiguration": { "type": "structure", "members": { "persistentAppUI": { "shape": "TemplateParameter", "documentation": "Monitoring configurations for the persistent application UI.
" }, "cloudWatchMonitoringConfiguration": { "shape": "ParametricCloudWatchMonitoringConfiguration", "documentation": "Monitoring configurations for CloudWatch.
" }, "s3MonitoringConfiguration": { "shape": "ParametricS3MonitoringConfiguration", "documentation": "Amazon S3 configuration for monitoring log publishing.
" } }, "documentation": "Configuration setting for monitoring. This data type allows job template parameters to be specified within.
" }, "ParametricReleaseLabel": { "type": "string", "max": 64, "min": 1, "pattern": "([\\.\\-_/A-Za-z0-9]+|\\$\\{[a-zA-Z]\\w*\\})" }, "ParametricS3MonitoringConfiguration": { "type": "structure", "members": { "logUri": { "shape": "UriString", "documentation": "Amazon S3 destination URI for log publishing.
" } }, "documentation": "Amazon S3 configuration for monitoring log publishing. You can configure your jobs to send log information to Amazon S3. This data type allows job template parameters to be specified within.
" }, "PersistentAppUI": { "type": "string", "enum": [ "ENABLED", "DISABLED" ] }, "ReleaseLabel": { "type": "string", "max": 64, "min": 1, "pattern": "[\\.\\-_/A-Za-z0-9]+" }, "RequestIdentityUserArn": { "type": "string", "max": 2048, "min": 20, "pattern": "^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\\d{12})?:[\\w/+=,.@-]+$" }, "ResourceIdString": { "type": "string", "max": 64, "min": 1, "pattern": "[0-9a-z]+" }, "ResourceNameString": { "type": "string", "max": 64, "min": 1, "pattern": "[\\.\\-_/#A-Za-z0-9]+" }, "RetryPolicyConfiguration": { "type": "structure", "required": [ "maxAttempts" ], "members": { "maxAttempts": { "shape": "JavaInteger", "documentation": "The maximum number of attempts on the job's driver.
" } }, "documentation": "The configuration of the retry policy that the job runs on.
" }, "RetryPolicyExecution": { "type": "structure", "required": [ "currentAttemptCount" ], "members": { "currentAttemptCount": { "shape": "JavaInteger", "documentation": "The current number of attempts made on the driver of the job.
" } }, "documentation": "The current status of the retry policy executed on the job.
" }, "RotationSize": { "type": "string", "max": 12, "min": 3, "pattern": "^\\d+(\\.\\d+)?[KMG][Bb]?$" }, "RsiArn": { "type": "string", "max": 500, "min": 60, "pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):/virtualclusters/.+$" }, "S3MonitoringConfiguration": { "type": "structure", "required": [ "logUri" ], "members": { "logUri": { "shape": "UriString", "documentation": "Amazon S3 destination URI for log publishing.
" } }, "documentation": "Amazon S3 configuration for monitoring log publishing. You can configure your jobs to send log information to Amazon S3.
" }, "SecretsManagerArn": { "type": "string", "max": 2048, "min": 3, "pattern": "^arn:(aws[a-zA-Z0-9-]*):secretsmanager:.+:(\\d{12}):secret:[0-9a-zA-Z/_+=.@-]+$" }, "SecureNamespaceInfo": { "type": "structure", "members": { "clusterId": { "shape": "ClusterId", "documentation": "The ID of the Amazon EKS cluster where Amazon EMR on EKS jobs run.
" }, "namespace": { "shape": "KubernetesNamespace", "documentation": "The namespace of the Amazon EKS cluster where the system jobs run.
" } }, "documentation": "Namespace inputs for the system job.
" }, "SecurityConfiguration": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "The ID of the security configuration.
" }, "name": { "shape": "ResourceNameString", "documentation": "The name of the security configuration.
" }, "arn": { "shape": "SecurityConfigurationArn", "documentation": "The ARN (Amazon Resource Name) of the security configuration.
" }, "createdAt": { "shape": "Date", "documentation": "The date and time that the job run was created.
" }, "createdBy": { "shape": "RequestIdentityUserArn", "documentation": "The user who created the job run.
" }, "securityConfigurationData": { "shape": "SecurityConfigurationData", "documentation": "Security configuration inputs for the request.
" }, "tags": { "shape": "TagMap", "documentation": "The tags to assign to the security configuration.
" } }, "documentation": "Inputs related to the security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.
" }, "SecurityConfigurationArn": { "type": "string", "max": 1024, "min": 60, "pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/securityconfigurations\\/[0-9a-zA-Z]+$" }, "SecurityConfigurationData": { "type": "structure", "members": { "authorizationConfiguration": { "shape": "AuthorizationConfiguration", "documentation": "Authorization-related configuration input for the security configuration.
" } }, "documentation": "Configurations related to the security configuration for the request.
" }, "SecurityConfigurations": { "type": "list", "member": { "shape": "SecurityConfiguration" } }, "SensitivePropertiesMap": { "type": "map", "key": { "shape": "String1024" }, "value": { "shape": "String1024" }, "max": 100, "sensitive": true }, "SessionTagValue": { "type": "string", "max": 512, "min": 1, "pattern": "[\\.\\-_/#A-Za-z0-9 ]+" }, "SparkSqlJobDriver": { "type": "structure", "members": { "entryPoint": { "shape": "EntryPointPath", "documentation": "The SQL file to be executed.
" }, "sparkSqlParameters": { "shape": "SparkSqlParameters", "documentation": "The Spark parameters to be included in the Spark SQL command.
" } }, "documentation": "The job driver for job type.
" }, "SparkSqlParameters": { "type": "string", "max": 102400, "min": 1, "pattern": ".*\\S.*", "sensitive": true }, "SparkSubmitJobDriver": { "type": "structure", "required": [ "entryPoint" ], "members": { "entryPoint": { "shape": "EntryPointPath", "documentation": "The entry point of job application.
" }, "entryPointArguments": { "shape": "EntryPointArguments", "documentation": "The arguments for job application.
" }, "sparkSubmitParameters": { "shape": "SparkSubmitParameters", "documentation": "The Spark submit parameters that are used for job runs.
" } }, "documentation": "The information about job driver for Spark submit.
" }, "SparkSubmitParameters": { "type": "string", "max": 102400, "min": 1, "pattern": ".*\\S.*", "sensitive": true }, "StartJobRunRequest": { "type": "structure", "required": [ "virtualClusterId", "clientToken" ], "members": { "name": { "shape": "ResourceNameString", "documentation": "The name of the job run.
" }, "virtualClusterId": { "shape": "ResourceIdString", "documentation": "The virtual cluster ID for which the job run request is submitted.
", "location": "uri", "locationName": "virtualClusterId" }, "clientToken": { "shape": "ClientToken", "documentation": "The client idempotency token of the job run request.
", "idempotencyToken": true }, "executionRoleArn": { "shape": "IAMRoleArn", "documentation": "The execution role ARN for the job run.
" }, "releaseLabel": { "shape": "ReleaseLabel", "documentation": "The Amazon EMR release version to use for the job run.
" }, "jobDriver": { "shape": "JobDriver", "documentation": "The job driver for the job run.
" }, "configurationOverrides": { "shape": "ConfigurationOverrides", "documentation": "The configuration overrides for the job run.
" }, "tags": { "shape": "TagMap", "documentation": "The tags assigned to job runs.
" }, "jobTemplateId": { "shape": "ResourceIdString", "documentation": "The job template ID to be used to start the job run.
" }, "jobTemplateParameters": { "shape": "TemplateParameterInputMap", "documentation": "The values of job template parameters to start a job run.
" }, "retryPolicyConfiguration": { "shape": "RetryPolicyConfiguration", "documentation": "The retry policy configuration for the job run.
" } } }, "StartJobRunResponse": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "This output displays the started job run ID.
" }, "name": { "shape": "ResourceNameString", "documentation": "This output displays the name of the started job run.
" }, "arn": { "shape": "JobArn", "documentation": "This output lists the ARN of job run.
" }, "virtualClusterId": { "shape": "ResourceIdString", "documentation": "This output displays the virtual cluster ID for which the job run was submitted.
" } } }, "String1024": { "type": "string", "max": 1024, "min": 1, "pattern": ".*\\S.*" }, "String128": { "type": "string", "max": 128, "min": 1, "pattern": ".*\\S.*" }, "String2048": { "type": "string", "max": 2048, "min": 1, "pattern": ".*\\S.*" }, "String256": { "type": "string", "max": 256, "min": 1, "pattern": ".*\\S.*" }, "StringEmpty256": { "type": "string", "max": 256, "min": 0, "pattern": ".*\\S.*" }, "SubnetIds": { "type": "list", "member": { "shape": "String256" } }, "TLSCertificateConfiguration": { "type": "structure", "members": { "certificateProviderType": { "shape": "CertificateProviderType", "documentation": "The TLS certificate type. Acceptable values: PEM
or Custom
.
Secrets Manager ARN that contains the public TLS certificate contents, used for communication between the user job and the system job.
" }, "privateCertificateSecretArn": { "shape": "SecretsManagerArn", "documentation": "Secrets Manager ARN that contains the private TLS certificate contents, used for communication between the user job and the system job.
" } }, "documentation": "Configurations related to the TLS certificate for the security configuration.
" }, "TagKeyList": { "type": "list", "member": { "shape": "String128" }, "max": 50, "min": 0 }, "TagMap": { "type": "map", "key": { "shape": "String128" }, "value": { "shape": "StringEmpty256" }, "max": 50, "min": 0 }, "TagResourceRequest": { "type": "structure", "required": [ "resourceArn", "tags" ], "members": { "resourceArn": { "shape": "RsiArn", "documentation": "The ARN of resources.
", "location": "uri", "locationName": "resourceArn" }, "tags": { "shape": "TagMap", "documentation": "The tags assigned to resources.
" } } }, "TagResourceResponse": { "type": "structure", "members": {} }, "TemplateParameter": { "type": "string", "max": 512, "min": 1, "pattern": "[\\.\\-_/#A-Za-z0-9\\$\\{\\}]+" }, "TemplateParameterConfiguration": { "type": "structure", "members": { "type": { "shape": "TemplateParameterDataType", "documentation": "The type of the job template parameter. Allowed values are: ‘STRING’, ‘NUMBER’.
" }, "defaultValue": { "shape": "String1024", "documentation": "The default value for the job template parameter.
" } }, "documentation": "The configuration of a job template parameter.
" }, "TemplateParameterConfigurationMap": { "type": "map", "key": { "shape": "TemplateParameterName" }, "value": { "shape": "TemplateParameterConfiguration" }, "max": 100 }, "TemplateParameterDataType": { "type": "string", "enum": [ "NUMBER", "STRING" ] }, "TemplateParameterInputMap": { "type": "map", "key": { "shape": "TemplateParameterName" }, "value": { "shape": "String1024" }, "max": 100 }, "TemplateParameterName": { "type": "string", "max": 512, "min": 1, "pattern": "[\\.\\-_\\#A-Za-z0-9]+" }, "Token": { "type": "string", "min": 1, "pattern": "^.*\\S.*$", "sensitive": true }, "UntagResourceRequest": { "type": "structure", "required": [ "resourceArn", "tagKeys" ], "members": { "resourceArn": { "shape": "RsiArn", "documentation": "The ARN of resources.
", "location": "uri", "locationName": "resourceArn" }, "tagKeys": { "shape": "TagKeyList", "documentation": "The tag keys of the resources.
", "location": "querystring", "locationName": "tagKeys" } } }, "UntagResourceResponse": { "type": "structure", "members": {} }, "UriString": { "type": "string", "max": 10280, "min": 1, "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*" }, "VirtualCluster": { "type": "structure", "members": { "id": { "shape": "ResourceIdString", "documentation": "The ID of the virtual cluster.
" }, "name": { "shape": "ResourceNameString", "documentation": "The name of the virtual cluster.
" }, "arn": { "shape": "VirtualClusterArn", "documentation": "The ARN of the virtual cluster.
" }, "state": { "shape": "VirtualClusterState", "documentation": "The state of the virtual cluster.
" }, "containerProvider": { "shape": "ContainerProvider", "documentation": "The container provider of the virtual cluster.
" }, "createdAt": { "shape": "Date", "documentation": "The date and time when the virtual cluster is created.
" }, "tags": { "shape": "TagMap", "documentation": "The assigned tags of the virtual cluster.
" }, "securityConfigurationId": { "shape": "ResourceIdString", "documentation": "The ID of the security configuration.
" } }, "documentation": "This entity describes a virtual cluster. A virtual cluster is a Kubernetes namespace that Amazon EMR is registered with. Amazon EMR uses virtual clusters to run jobs and host endpoints. Multiple virtual clusters can be backed by the same physical cluster. However, each virtual cluster maps to one namespace on an Amazon EKS cluster. Virtual clusters do not create any active resources that contribute to your bill or that require lifecycle management outside the service.
" }, "VirtualClusterArn": { "type": "string", "max": 1024, "min": 60, "pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+$" }, "VirtualClusterState": { "type": "string", "enum": [ "RUNNING", "TERMINATING", "TERMINATED", "ARRESTED" ] }, "VirtualClusterStates": { "type": "list", "member": { "shape": "VirtualClusterState" }, "max": 10 }, "VirtualClusters": { "type": "list", "member": { "shape": "VirtualCluster" } } }, "documentation": "Amazon EMR on EKS provides a deployment option for Amazon EMR that allows you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS). With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications. For more information about Amazon EMR on EKS concepts and tasks, see What is Amazon EMR on EKS.
Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers
prefix is used in the following scenarios:
It is the prefix in the CLI commands for Amazon EMR on EKS. For example, aws emr-containers start-job-run
.
It is the prefix before IAM policy actions for Amazon EMR on EKS. For example, \"Action\": [ \"emr-containers:StartJobRun\"]
. For more information, see Policy actions for Amazon EMR on EKS.
It is the prefix used in Amazon EMR on EKS service endpoints. For example, emr-containers.us-east-2.amazonaws.com
. For more information, see Amazon EMR on EKSService Endpoints.