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-datazone:amazon-datazone-group-profiles-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 DataZone Group Profiles API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for Amazon DataZone. 3 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://datazone.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Group Profiles
paths:
  /v2/domains/{domainIdentifier}/group-profiles:
    post:
      operationId: CreateGroupProfile
      summary: Create Group Profile
      description: Creates a group profile in Amazon DataZone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGroupProfileOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroupProfileInput'
      tags:
      - Group Profiles
  /v2/domains/{domainIdentifier}/group-profiles/{groupIdentifier}:
    get:
      operationId: GetGroupProfile
      summary: Get Group Profile
      description: Gets a group profile in Amazon DataZone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupProfileOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetGroupProfileInput'
      tags:
      - Group Profiles
    put:
      operationId: UpdateGroupProfile
      summary: Update Group Profile
      description: Updates the specified group profile in Amazon DataZone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateGroupProfileOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGroupProfileInput'
      tags:
      - Group Profiles
components:
  schemas:
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetGroupProfileInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the Amazon DataZone domain in which the group profile exists.
        groupIdentifier:
          type: string
          description: The identifier of the group profile.
      required:
      - domainIdentifier
      - groupIdentifier
    GetGroupProfileOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The identifier of the Amazon DataZone domain in which the group profile exists.
        id:
          type: string
          description: The identifier of the group profile.
        status:
          type: string
          enum:
          - ASSIGNED
          - NOT_ASSIGNED
          description: The identifier of the group profile.
        groupName:
          type: string
          description: The name of the group for which the specified group profile exists.
        rolePrincipalArn:
          type: string
          description: The ARN of the IAM role principal. This role is associated with the group profile.
        rolePrincipalId:
          type: string
          description: The unique identifier of the IAM role principal. This principal is associated with the group profile.
    CreateGroupProfileOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The identifier of the Amazon DataZone domain in which the group profile is created.
        id:
          type: string
          description: The identifier of the group profile.
        status:
          type: string
          enum:
          - ASSIGNED
          - NOT_ASSIGNED
          description: The status of the group profile.
        groupName:
          type: string
          description: The name of the group for which group profile is created.
        rolePrincipalArn:
          type: string
          description: The ARN of the IAM role principal. This role is associated with the group profile.
        rolePrincipalId:
          type: string
          description: The unique identifier of the IAM role principal. This principal is associated with the group profile.
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateGroupProfileOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The identifier of the Amazon DataZone domain in which a group profile is updated.
        id:
          type: string
          description: The identifier of the group profile that is updated.
        status:
          type: string
          enum:
          - ASSIGNED
          - NOT_ASSIGNED
          description: The status of the group profile that is updated.
        groupName:
          type: string
          description: The name of the group profile that is updated.
        rolePrincipalArn:
          type: string
          description: The ARN of the IAM role principal. This role is associated with the updated group profile.
        rolePrincipalId:
          type: string
          description: The unique identifier of the IAM role principal. This principal is associated with the updated group profile.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreateGroupProfileInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the Amazon DataZone domain in which the group profile is created.
        groupIdentifier:
          type: string
          description: The identifier of the group for which the group profile is created.
        rolePrincipalArn:
          type: string
          description: The ARN of the IAM role that will be associated with the group profile. This role defines the permissions that group members will assume when accessing Amazon DataZone resources.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
      required:
      - domainIdentifier
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateGroupProfileInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the Amazon DataZone domain in which a group profile is updated.
        groupIdentifier:
          type: string
          description: The identifier of the group profile that is updated.
        status:
          type: string
          enum:
          - ASSIGNED
          - NOT_ASSIGNED
          description: The status of the group profile that is updated.
      required:
      - domainIdentifier
      - groupIdentifier
      - status
  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: datazone
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/datazone/service/2018-05-10/datazone-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)