openapi: 3.0.0 info: version: '2018-09-22' x-release: v4 title: CodeArtifact Authorization Token# Domain API description: '

CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.

CodeArtifact Components

Use the information in this guide to help you work with the following CodeArtifact components:

CodeArtifact supports these operations:

' 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: codeartifact x-aws-signingName: codeartifact x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codeartifact-2018-09-22.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://codeartifact.{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 CodeArtifact multi-region endpoint - url: https://codeartifact.{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 CodeArtifact multi-region endpoint - url: http://codeartifact.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The CodeArtifact endpoint for China (Beijing) and China (Ningxia) - url: https://codeartifact.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The CodeArtifact endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Domain paths: /v1/domain/permissions/policy#domain: 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' delete: operationId: DeleteDomainPermissionsPolicy description: ' Deletes the resource policy set on a domain. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteDomainPermissionsPolicyResult' examples: DeleteDomainPermissionsPolicy200Example: summary: Default DeleteDomainPermissionsPolicy 200 response x-microcks-default: true value: policy: example-value '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: DeleteDomainPermissionsPolicy480Example: summary: Default DeleteDomainPermissionsPolicy 480 response x-microcks-default: true value: example-value '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: DeleteDomainPermissionsPolicy481Example: summary: Default DeleteDomainPermissionsPolicy 481 response x-microcks-default: true value: example-value '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DeleteDomainPermissionsPolicy482Example: summary: Default DeleteDomainPermissionsPolicy 482 response x-microcks-default: true value: example-value '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DeleteDomainPermissionsPolicy483Example: summary: Default DeleteDomainPermissionsPolicy 483 response x-microcks-default: true value: example-value '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: DeleteDomainPermissionsPolicy484Example: summary: Default DeleteDomainPermissionsPolicy 484 response x-microcks-default: true value: example-value '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: DeleteDomainPermissionsPolicy485Example: summary: Default DeleteDomainPermissionsPolicy 485 response x-microcks-default: true value: '500123' parameters: - name: domain in: query required: true description: ' The name of the domain associated with the resource policy to be deleted. ' schema: type: string pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]' minLength: 2 maxLength: 50 - name: domain-owner in: query required: false description: ' The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. ' schema: type: string pattern: '[0-9]{12}' minLength: 12 maxLength: 12 - name: policy-revision in: query required: false description: ' The current revision of the resource policy to be deleted. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain''s resource policy. ' schema: type: string pattern: \S+ minLength: 1 maxLength: 100 summary: Amazon CodeArtifact Delete Domain Permissions Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Domain get: operationId: GetDomainPermissionsPolicy description:

Returns the resource policy attached to the specified domain.

The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies in the IAM User Guide.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDomainPermissionsPolicyResult' examples: GetDomainPermissionsPolicy200Example: summary: Default GetDomainPermissionsPolicy 200 response x-microcks-default: true value: policy: example-value '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetDomainPermissionsPolicy480Example: summary: Default GetDomainPermissionsPolicy 480 response x-microcks-default: true value: example-value '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetDomainPermissionsPolicy481Example: summary: Default GetDomainPermissionsPolicy 481 response x-microcks-default: true value: example-value '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetDomainPermissionsPolicy482Example: summary: Default GetDomainPermissionsPolicy 482 response x-microcks-default: true value: example-value '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetDomainPermissionsPolicy483Example: summary: Default GetDomainPermissionsPolicy 483 response x-microcks-default: true value: example-value '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: GetDomainPermissionsPolicy484Example: summary: Default GetDomainPermissionsPolicy 484 response x-microcks-default: true value: '500123' parameters: - name: domain in: query required: true description: ' The name of the domain to which the resource policy is attached. ' schema: type: string pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]' minLength: 2 maxLength: 50 - name: domain-owner in: query required: false description: ' The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. ' schema: type: string pattern: '[0-9]{12}' minLength: 12 maxLength: 12 summary: Amazon CodeArtifact Get Domain Permissions Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Domain /v1/domain/repositories#domain: 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: ListRepositoriesInDomain description: ' Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListRepositoriesInDomainResult' examples: ListRepositoriesInDomain200Example: summary: Default ListRepositoriesInDomain 200 response x-microcks-default: true value: repositories: my-repo nextToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ListRepositoriesInDomain480Example: summary: Default ListRepositoriesInDomain 480 response x-microcks-default: true value: example-value '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListRepositoriesInDomain481Example: summary: Default ListRepositoriesInDomain 481 response x-microcks-default: true value: example-value '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ListRepositoriesInDomain482Example: summary: Default ListRepositoriesInDomain 482 response x-microcks-default: true value: example-value '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ListRepositoriesInDomain483Example: summary: Default ListRepositoriesInDomain 483 response x-microcks-default: true value: example-value '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListRepositoriesInDomain484Example: summary: Default ListRepositoriesInDomain 484 response x-microcks-default: true value: '500123' parameters: - name: domain in: query required: true description: ' The name of the domain that contains the returned list of repositories. ' schema: type: string pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]' minLength: 2 maxLength: 50 - name: domain-owner in: query required: false description: ' The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. ' schema: type: string pattern: '[0-9]{12}' minLength: 12 maxLength: 12 - name: administrator-account in: query required: false description: ' Filter the list of repositories to only include those that are managed by the Amazon Web Services account ID. ' schema: type: string pattern: '[0-9]{12}' minLength: 12 maxLength: 12 - name: repository-prefix in: query required: false description: ' A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned. ' schema: type: string pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}' minLength: 2 maxLength: 100 - name: max-results in: query required: false description: ' The maximum number of results to return per page. ' schema: type: integer minimum: 1 maximum: 1000 - name: next-token in: query required: false description: ' The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. ' schema: type: string pattern: \S+ minLength: 1 maxLength: 2000 - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false summary: Amazon CodeArtifact List Repositories in Domain x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Domain /v1/domain/permissions/policy: 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' put: operationId: PutDomainPermissionsPolicy description:

Sets a resource policy on a domain that specifies permissions to access it.

When you call PutDomainPermissionsPolicy, the resource policy on the domain is ignored when evaluting permissions. This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being able to update the resource policy.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutDomainPermissionsPolicyResult' examples: PutDomainPermissionsPolicy200Example: summary: Default PutDomainPermissionsPolicy 200 response x-microcks-default: true value: policy: example-value '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: PutDomainPermissionsPolicy480Example: summary: Default PutDomainPermissionsPolicy 480 response x-microcks-default: true value: example-value '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: PutDomainPermissionsPolicy481Example: summary: Default PutDomainPermissionsPolicy 481 response x-microcks-default: true value: example-value '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: PutDomainPermissionsPolicy482Example: summary: Default PutDomainPermissionsPolicy 482 response x-microcks-default: true value: example-value '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: PutDomainPermissionsPolicy483Example: summary: Default PutDomainPermissionsPolicy 483 response x-microcks-default: true value: example-value '484': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' examples: PutDomainPermissionsPolicy484Example: summary: Default PutDomainPermissionsPolicy 484 response x-microcks-default: true value: example-value '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: PutDomainPermissionsPolicy485Example: summary: Default PutDomainPermissionsPolicy 485 response x-microcks-default: true value: example-value '486': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: PutDomainPermissionsPolicy486Example: summary: Default PutDomainPermissionsPolicy 486 response x-microcks-default: true value: '500123' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - domain - policyDocument properties: domain: description: ' The name of the domain on which to set the resource policy. ' type: string pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]' minLength: 2 maxLength: 50 domainOwner: description: ' The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. ' type: string pattern: '[0-9]{12}' minLength: 12 maxLength: 12 policyRevision: description: ' The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain''s resource policy. ' type: string pattern: \S+ minLength: 1 maxLength: 100 policyDocument: description: ' A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain. ' type: string pattern: '[\P{C}\s]+' minLength: 1 maxLength: 7168 examples: PutDomainPermissionsPolicyRequestExample: summary: Default PutDomainPermissionsPolicy request x-microcks-default: true value: domain: my-domain domainOwner: my-domain policyRevision: example-value policyDocument: example-value summary: Amazon CodeArtifact Put Domain Permissions Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Domain components: schemas: InternalServerException: {} RepositorySummary: type: object properties: name: allOf: - $ref: '#/components/schemas/RepositoryName' - description: ' The name of the repository. ' administratorAccount: allOf: - $ref: '#/components/schemas/AccountId' - description: ' The Amazon Web Services account ID that manages the repository. ' domainName: allOf: - $ref: '#/components/schemas/DomainName' - description: ' The name of the domain that contains the repository. ' domainOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: ' The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. ' arn: allOf: - $ref: '#/components/schemas/Arn' - description: ' The ARN of the repository. ' description: allOf: - $ref: '#/components/schemas/Description' - description: ' The description of the repository. ' createdTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: A timestamp that represents the date and time the repository was created. description: ' Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The ListRepositories operation returns a list of RepositorySummary objects. ' GetDomainPermissionsPolicyResult: type: object properties: policy: allOf: - $ref: '#/components/schemas/ResourcePolicy' - description: ' The returned resource policy. ' AccountId: type: string pattern: '[0-9]{12}' minLength: 12 maxLength: 12 PaginationToken: type: string pattern: \S+ minLength: 1 maxLength: 2000 ValidationException: {} ListRepositoriesInDomainResult: type: object properties: repositories: allOf: - $ref: '#/components/schemas/RepositorySummaryList' - description: ' The returned list of repositories. ' nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: ' If there are additional results, this is the token for the next set of results. ' DeleteDomainPermissionsPolicyResult: type: object properties: policy: allOf: - $ref: '#/components/schemas/ResourcePolicy' - description: ' Information about the deleted resource policy after processing the request. ' ThrottlingException: {} ServiceQuotaExceededException: {} ResourcePolicy: type: object properties: resourceArn: allOf: - $ref: '#/components/schemas/Arn' - description: ' The ARN of the resource associated with the resource policy ' revision: allOf: - $ref: '#/components/schemas/PolicyRevision' - description: ' The current revision of the resource policy. ' document: allOf: - $ref: '#/components/schemas/PolicyDocument' - description: ' The resource policy formatted in JSON. ' description: ' An CodeArtifact resource policy that contains a resource ARN, document details, and a revision. ' AccessDeniedException: {} PolicyDocument: type: string pattern: '[\P{C}\s]+' minLength: 1 maxLength: 7168 ConflictException: {} RepositorySummaryList: type: array items: $ref: '#/components/schemas/RepositorySummary' DomainName: type: string pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]' minLength: 2 maxLength: 50 Timestamp: type: string format: date-time ResourceNotFoundException: {} RepositoryName: type: string pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}' minLength: 2 maxLength: 100 Description: type: string pattern: \P{C}* maxLength: 1000 PutDomainPermissionsPolicyResult: type: object properties: policy: allOf: - $ref: '#/components/schemas/ResourcePolicy' - description: ' The resource policy that was set after processing the request. ' PolicyRevision: type: string pattern: \S+ minLength: 1 maxLength: 100 Arn: type: string pattern: \S+ minLength: 1 maxLength: 1011 parameters: X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature 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-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false 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/codeartifact/ x-hasEquivalentPaths: true