find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-emr:amazon-emr-studio-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon EMR Studio API
  version: '2009-03-31'
  description: Generated from AWS's published Smithy model for Amazon EMR. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://elasticmapreduce.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Studio
paths:
  /#CreateStudio:
    post:
      operationId: CreateStudio
      summary: Create Studio
      description: Creates a new Amazon EMR Studio.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateStudioOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - ElasticMapReduce.CreateStudio
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateStudioInput'
      tags:
      - Studio
  /#DeleteStudio:
    post:
      operationId: DeleteStudio
      summary: Delete Studio
      description: Removes an Amazon EMR Studio from the Studio metadata store.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - ElasticMapReduce.DeleteStudio
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteStudioInput'
      tags:
      - Studio
  /#DescribeStudio:
    post:
      operationId: DescribeStudio
      summary: Describe Studio
      description: Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeStudioOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - ElasticMapReduce.DescribeStudio
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeStudioInput'
      tags:
      - Studio
  /#ListStudios:
    post:
      operationId: ListStudios
      summary: List Studios
      description: Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list includes details such as ID, Studio Access URL, and creation time for each Studio.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListStudiosOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - ElasticMapReduce.ListStudios
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListStudiosInput'
      tags:
      - Studio
  /#UpdateStudio:
    post:
      operationId: UpdateStudio
      summary: Update Studio
      description: Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - ElasticMapReduce.UpdateStudio
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateStudioInput'
      tags:
      - Studio
components:
  schemas:
    UpdateStudioInput:
      type: object
      properties:
        StudioId:
          type: string
          description: The ID of the Amazon EMR Studio to update.
        Name:
          type: string
          description: A descriptive name for the Amazon EMR Studio.
        Description:
          type: string
          description: A detailed description to assign to the Amazon EMR Studio.
        SubnetIds:
          type: array
          items:
            type: string
          description: A list of subnet IDs to associate with the Amazon EMR Studio. The list can include new subnet IDs, but must also include all of the subnet IDs previously associated with the Studio. The list order does not matter. A Studio can have a maximum of 5 subnets. The subnets must belong to the same VPC as the Studio.
        DefaultS3Location:
          type: string
          description: The Amazon S3 location to back up Workspaces and notebook files for the Amazon EMR Studio.
        EncryptionKeyArn:
          type: string
          description: The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
      required:
      - StudioId
    DescribeStudioOutput:
      type: object
      properties:
        Studio:
          $ref: '#/components/schemas/Studio'
    CreateStudioInput:
      type: object
      properties:
        Name:
          type: string
          description: A descriptive name for the Amazon EMR Studio.
        Description:
          type: string
          description: A detailed description of the Amazon EMR Studio.
        AuthMode:
          type: string
          enum:
          - SSO
          - IAM
          description: Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
        VpcId:
          type: string
          description: The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
        SubnetIds:
          type: array
          items:
            type: string
          description: A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
        ServiceRole:
          type: string
          description: The IAM role that the Amazon EMR Studio assumes. The service role provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services services.
        UserRole:
          type: string
          description: The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole when you use IAM Identity Center authentication. The permissions attached to the UserRole can be scoped down for each user or group using session policies.
        WorkspaceSecurityGroupId:
          type: string
          description: The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId.
        EngineSecurityGroupId:
          type: string
          description: The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId.
        DefaultS3Location:
          type: string
          description: The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
        IdpAuthUrl:
          type: string
          description: The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.
        IdpRelayStateParameterName:
          type: string
          description: The name that your identity provider (IdP) uses for its RelayState parameter. For example, RelayState or TargetSource. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The RelayState parameter differs by IdP.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
        TrustedIdentityPropagationEnabled:
          type: boolean
          description: A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
        IdcUserAssignment:
          type: string
          enum:
          - REQUIRED
          - OPTIONAL
          description: Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
        IdcInstanceArn:
          type: string
          description: The ARN of the IAM Identity Center instance to create the Studio application.
        EncryptionKeyArn:
          type: string
          description: The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
      required:
      - Name
      - AuthMode
      - VpcId
      - SubnetIds
      - ServiceRole
      - WorkspaceSecurityGroupId
      - EngineSecurityGroupId
      - DefaultS3Location
    CreateStudioOutput:
      type: object
      properties:
        StudioId:
          type: string
          description: The ID of the Amazon EMR Studio.
        Url:
          type: string
          description: The unique Studio access URL.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
          description: The message associated with the exception.
    ListStudiosOutput:
      type: object
      properties:
        Studios:
          type: array
          items:
            $ref: '#/components/schemas/StudioSummary'
          description: The list of Studio summary objects.
        Marker:
          type: string
          description: The pagination token that indicates the next set of results to retrieve.
    ListStudiosInput:
      type: object
      properties:
        Marker:
          type: string
          description: The pagination token that indicates the set of results to retrieve.
    DescribeStudioInput:
      type: object
      properties:
        StudioId:
          type: string
          description: The Amazon EMR Studio ID.
      required:
      - StudioId
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag.
        Value:
          type: string
          description: A user-defined value, which is optional in a tag. For more information, see Tag Clusters.
    Studio:
      type: object
      properties:
        StudioId:
          type: string
          description: The ID of the Amazon EMR Studio.
        StudioArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon EMR Studio.
        Name:
          type: string
          description: The name of the Amazon EMR Studio.
        Description:
          type: string
          description: The detailed description of the Amazon EMR Studio.
        AuthMode:
          type: string
          enum:
          - SSO
          - IAM
          description: Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.
        VpcId:
          type: string
          description: The ID of the VPC associated with the Amazon EMR Studio.
        SubnetIds:
          type: array
          items:
            type: string
          description: The list of IDs of the subnets associated with the Amazon EMR Studio.
        ServiceRole:
          type: string
          description: The name of the IAM role assumed by the Amazon EMR Studio.
        UserRole:
          type: string
          description: The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A Studio only requires a UserRole when you use IAM authentication.
        WorkspaceSecurityGroupId:
          type: string
          description: The ID of the Workspace security group associated with the Amazon EMR Studio. The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.
        EngineSecurityGroupId:
          type: string
          description: The ID of the Engine security group associated with the Amazon EMR Studio. The Engine security group allows inbound network traffic from resources in the Workspace security group.
        Url:
          type: string
          description: The unique access URL of the Amazon EMR Studio.
        CreationTime:
          type: string
          format: date-time
          description: The time the Amazon EMR Studio was created.
        DefaultS3Location:
          type: string
          description: The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
        IdpAuthUrl:
          type: string
          description: Your identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
        IdpRelayStateParameterName:
          type: string
          description: The name of your identity provider's RelayState parameter.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags associated with the Amazon EMR Studio.
        IdcInstanceArn:
          type: string
          description: The ARN of the IAM Identity Center instance the Studio application belongs to.
        TrustedIdentityPropagationEnabled:
          type: boolean
          description: Indicates whether the Studio has Trusted identity propagation enabled. The default value is false.
        IdcUserAssignment:
          type: string
          enum:
          - REQUIRED
          - OPTIONAL
          description: Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
        EncryptionKeyArn:
          type: string
          description: The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
    InvalidRequestException:
      type: object
      properties:
        ErrorCode:
          type: string
          description: The error code associated with the exception.
        Message:
          type: string
          description: The message associated with the exception.
    DeleteStudioInput:
      type: object
      properties:
        StudioId:
          type: string
          description: The ID of the Amazon EMR Studio.
      required:
      - StudioId
    StudioSummary:
      type: object
      properties:
        StudioId:
          type: string
          description: The ID of the Amazon EMR Studio.
        Name:
          type: string
          description: The name of the Amazon EMR Studio.
        VpcId:
          type: string
          description: The ID of the Virtual Private Cloud (Amazon VPC) associated with the Amazon EMR Studio.
        Description:
          type: string
          description: The detailed description of the Amazon EMR Studio.
        Url:
          type: string
          description: The unique access URL of the Amazon EMR Studio.
        AuthMode:
          type: string
          enum:
          - SSO
          - IAM
          description: Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
        CreationTime:
          type: string
          format: date-time
          description: The time when the Amazon EMR Studio was created.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: elasticmapreduce
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/emr/service/2009-03-31/emr-2009-03-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)