openapi: 3.0.0 info: version: '2017-04-19' x-release: v4 title: 'AWS CodeStar #X Amz Target=CodeStar 20170419.AssociateTeamMember #X Amz Target=CodeStar 20170419.AssociateTeamMember #X Amz Target=CodeStar 20170419.ListUserProfiles API' description: AWS CodeStar

This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.

You can use the AWS CodeStar API to work with:

Projects and their resources, by calling the following:

Teams and team members, by calling the following:

Users, by calling the following:

x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: codestar x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codestar-2017-04-19.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://codestar.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The CodeStar multi-region endpoint - url: https://codestar.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The CodeStar multi-region endpoint - url: http://codestar.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The CodeStar endpoint for China (Beijing) and China (Ningxia) - url: https://codestar.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The CodeStar endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=CodeStar 20170419.ListUserProfiles' paths: /#X-Amz-Target=CodeStar_20170419.ListUserProfiles: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListUserProfiles description: Lists all the user profiles configured for your AWS account in AWS CodeStar. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListUserProfilesResult' examples: ListUserProfiles200Example: summary: Default ListUserProfiles 200 response x-microcks-default: true value: userProfiles: example nextToken: example '480': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListUserProfiles480Example: summary: Default ListUserProfiles 480 response x-microcks-default: true value: example '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListUserProfiles481Example: summary: Default ListUserProfiles 481 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListUserProfilesRequest' examples: ListUserProfilesRequestExample: summary: Default ListUserProfiles request x-microcks-default: true value: nextToken: example maxResults: example parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeStar_20170419.ListUserProfiles summary: Amazon CodeStar List User Profiles x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=CodeStar 20170419.ListUserProfiles' components: parameters: X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false schemas: ValidationException: {} UserArn: type: string pattern: ^arn:aws:iam::\d{12}:user(?:(\u002F)|(\u002F[\u0021-\u007E]+\u002F))[\w+=,.@-]+$ minLength: 32 maxLength: 95 ListUserProfilesRequest: type: object title: ListUserProfilesRequest properties: nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: The continuation token for the next set of results, if the results cannot be returned in one response. maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: The maximum number of results to return in a response. UserProfilesList: type: array items: $ref: '#/components/schemas/UserProfileSummary' UserProfileSummary: type: object properties: userArn: allOf: - $ref: '#/components/schemas/UserArn' - description: The Amazon Resource Name (ARN) of the user in IAM. displayName: allOf: - $ref: '#/components/schemas/UserProfileDisplayName' - description: The display name of a user in AWS CodeStar. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM"). emailAddress: allOf: - $ref: '#/components/schemas/Email' - description: The email address associated with the user. sshPublicKey: allOf: - $ref: '#/components/schemas/SshPublicKey' - description: The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access. description: Information about a user's profile in AWS CodeStar. InvalidNextTokenException: {} PaginationToken: type: string pattern: ^[\w/+=]+$ minLength: 1 maxLength: 512 ListUserProfilesResult: type: object required: - userProfiles properties: userProfiles: allOf: - $ref: '#/components/schemas/UserProfilesList' - description: All the user profiles configured in AWS CodeStar for an AWS account. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: The continuation token to use when requesting the next set of results, if there are more results to be returned. Email: type: string pattern: ^[\w-.+]+@[\w-.+]+$ minLength: 3 maxLength: 128 format: password SshPublicKey: type: string pattern: ^[\t\r\n\u0020-\u00FF]*$ maxLength: 16384 MaxResults: type: integer minimum: 1 maximum: 100 UserProfileDisplayName: type: string pattern: ^\S(.*\S)?$ minLength: 1 maxLength: 64 format: password securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/codestar/ x-hasEquivalentPaths: true