openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 200 kB
JSON
{"openapi":"3.0.0","info":{"version":"2018-09-22","x-release":"v4","title":"CodeArtifact","description":"<p> 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. </p> <p> <b>CodeArtifact Components</b> </p> <p>Use the information in this guide to help you work with the following CodeArtifact components:</p> <ul> <li> <p> <b>Repository</b>: A CodeArtifact repository contains a set of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version\">package versions</a>, each of which maps to a set of assets, or files. Repositories are polyglot, so a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the <b> <code>npm</code> </b> CLI, the Maven CLI (<b> <code>mvn</code> </b>), Python CLIs (<b> <code>pip</code> </b> and <code>twine</code>), and NuGet CLIs (<code>nuget</code> and <code>dotnet</code>).</p> </li> <li> <p> <b>Domain</b>: Repositories are aggregated into a higher-level entity known as a <i>domain</i>. All package assets and metadata are stored in the domain, but are consumed through repositories. A given package asset, such as a Maven JAR file, is stored once per domain, no matter how many repositories it's present in. All of the assets and metadata in a domain are encrypted with the same customer master key (CMK) stored in Key Management Service (KMS).</p> <p>Each repository is a member of a single domain and can't be moved to a different domain.</p> <p>The domain allows organizational policy to be applied across multiple repositories, such as which accounts can access repositories in the domain, and which public repositories can be used as sources of packages.</p> <p>Although an organization can have multiple domains, we recommend a single production domain that contains all published artifacts so that teams can find and share packages across their organization.</p> </li> <li> <p> <b>Package</b>: A <i>package</i> is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html\">npm</a>, <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html\">PyPI</a>, <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven\">Maven</a>, and <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/using-nuget\">NuGet</a> package formats.</p> <p>In CodeArtifact, a package consists of:</p> <ul> <li> <p>A <i>name</i> (for example, <code>webpack</code> is the name of a popular npm package)</p> </li> <li> <p>An optional namespace (for example, <code>@types</code> in <code>@types/node</code>)</p> </li> <li> <p>A set of versions (for example, <code>1.0.0</code>, <code>1.0.1</code>, <code>1.0.2</code>, etc.)</p> </li> <li> <p> Package-level metadata (for example, npm tags)</p> </li> </ul> </li> <li> <p> <b>Package version</b>: A version of a package, such as <code>@types/node 12.6.9</code>. The version number format and semantics vary for different package formats. For example, npm package versions must conform to the <a href=\"https://semver.org/\">Semantic Versioning specification</a>. In CodeArtifact, a package version consists of the version identifier, metadata at the package version level, and a set of assets.</p> </li> <li> <p> <b>Upstream repository</b>: One repository is <i>upstream</i> of another when the package versions in it can be accessed from the repository endpoint of the downstream repository, effectively merging the contents of the two repositories from the point of view of a client. CodeArtifact allows creating an upstream relationship between two repositories.</p> </li> <li> <p> <b>Asset</b>: An individual file stored in CodeArtifact associated with a package version, such as an npm <code>.tgz</code> file or Maven POM and JAR files.</p> </li> </ul> <p>CodeArtifact supports these operations:</p> <ul> <li> <p> <code>AssociateExternalConnection</code>: Adds an existing external connection to a repository. </p> </li> <li> <p> <code>CopyPackageVersions</code>: Copies package versions from one repository to another repository in the same domain.</p> </li> <li> <p> <code>CreateDomain</code>: Creates a domain</p> </li> <li> <p> <code>CreateRepository</code>: Creates a CodeArtifact repository in a domain. </p> </li> <li> <p> <code>DeleteDomain</code>: Deletes a domain. You cannot delete a domain that contains repositories. </p> </li> <li> <p> <code>DeleteDomainPermissionsPolicy</code>: Deletes the resource policy that is set on a domain.</p> </li> <li> <p> <code>DeletePackage</code>: Deletes a package and all associated package versions.</p> </li> <li> <p> <code>DeletePackageVersions</code>: Deletes versions of a package. After a package has been deleted, it can be republished, but its assets and metadata cannot be restored because they have been permanently removed from storage.</p> </li> <li> <p> <code>DeleteRepository</code>: Deletes a repository. </p> </li> <li> <p> <code>DeleteRepositoryPermissionsPolicy</code>: Deletes the resource policy that is set on a repository.</p> </li> <li> <p> <code>DescribeDomain</code>: Returns a <code>DomainDescription</code> object that contains information about the requested domain.</p> </li> <li> <p> <code>DescribePackage</code>: Returns a <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html\">PackageDescription</a> object that contains details about a package. </p> </li> <li> <p> <code>DescribePackageVersion</code>: Returns a <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html\">PackageVersionDescription</a> object that contains details about a package version. </p> </li> <li> <p> <code>DescribeRepository</code>: Returns a <code>RepositoryDescription</code> object that contains detailed information about the requested repository. </p> </li> <li> <p> <code>DisposePackageVersions</code>: Disposes versions of a package. A package version with the status <code>Disposed</code> cannot be restored because they have been permanently removed from storage.</p> </li> <li> <p> <code>DisassociateExternalConnection</code>: Removes an existing external connection from a repository. </p> </li> <li> <p> <code>GetAuthorizationToken</code>: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.</p> </li> <li> <p> <code>GetDomainPermissionsPolicy</code>: Returns the policy of a resource that is attached to the specified domain. </p> </li> <li> <p> <code>GetPackageVersionAsset</code>: Returns the contents of an asset that is in a package version. </p> </li> <li> <p> <code>GetPackageVersionReadme</code>: Gets the readme file or descriptive text for a package version.</p> </li> <li> <p> <code>GetRepositoryEndpoint</code>: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format: </p> <ul> <li> <p> <code>maven</code> </p> </li> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>nuget</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> </ul> </li> <li> <p> <code>GetRepositoryPermissionsPolicy</code>: Returns the resource policy that is set on a repository. </p> </li> <li> <p> <code>ListDomains</code>: Returns a list of <code>DomainSummary</code> objects. Each returned <code>DomainSummary</code> object contains information about a domain.</p> </li> <li> <p> <code>ListPackages</code>: Lists the packages in a repository.</p> </li> <li> <p> <code>ListPackageVersionAssets</code>: Lists the assets for a given package version.</p> </li> <li> <p> <code>ListPackageVersionDependencies</code>: Returns a list of the direct dependencies for a package version. </p> </li> <li> <p> <code>ListPackageVersions</code>: Returns a list of package versions for a specified package in a repository.</p> </li> <li> <p> <code>ListRepositories</code>: Returns a list of repositories owned by the Amazon Web Services account that called this method.</p> </li> <li> <p> <code>ListRepositoriesInDomain</code>: Returns a list of the repositories in a domain.</p> </li> <li> <p> <code>PublishPackageVersion</code>: Creates a new package version containing one or more assets.</p> </li> <li> <p> <code>PutDomainPermissionsPolicy</code>: Attaches a resource policy to a domain.</p> </li> <li> <p> <code>PutPackageOriginConfiguration</code>: Sets the package origin configuration for a package, which determine how new versions of the package can be added to a specific repository.</p> </li> <li> <p> <code>PutRepositoryPermissionsPolicy</code>: Sets the resource policy on a repository that specifies permissions to access it. </p> </li> <li> <p> <code>UpdatePackageVersionsStatus</code>: Updates the status of one or more versions of a package.</p> </li> <li> <p> <code>UpdateRepository</code>: Updates the properties of a repository.</p> </li> </ul>","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},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/codeartifact/"},"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)"}],"x-hasEquivalentPaths":true,"paths":{"/v1/repository/external-connection#domain&repository&external-connection":{"post":{"operationId":"AssociateExternalConnection","description":"<p>Adds an existing external connection to a repository. One external connection is allowed per repository.</p> <note> <p>A repository can have one or more upstream repositories, or an external connection.</p> </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssociateExternalConnectionResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"486":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"domain","in":"query","required":true,"description":"The name of the domain that contains the repository.","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":"repository","in":"query","required":true,"description":" The name of the repository to which the external connection is added. ","schema":{"type":"string","pattern":"[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}","minLength":2,"maxLength":100}},{"name":"external-connection","in":"query","required":true,"description":"<p> The name of the external connection to add to the repository. The following values are supported: </p> <ul> <li> <p> <code>public:npmjs</code> - for the npm public repository. </p> </li> <li> <p> <code>public:nuget-org</code> - for the NuGet Gallery. </p> </li> <li> <p> <code>public:pypi</code> - for the Python Package Index. </p> </li> <li> <p> <code>public:maven-central</code> - for Maven Central. </p> </li> <li> <p> <code>public:maven-googleandroid</code> - for the Google Android repository. </p> </li> <li> <p> <code>public:maven-gradleplugins</code> - for the Gradle plugins repository. </p> </li> <li> <p> <code>public:maven-commonsware</code> - for the CommonsWare Android repository. </p> </li> <li> <p> <code>public:maven-clojars</code> - for the Clojars repository. </p> </li> </ul>","schema":{"type":"string","pattern":"[A-Za-z0-9][A-Za-z0-9._\\-:]{1,99}","minLength":2,"maxLength":100}}]},"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":"DisassociateExternalConnection","description":" Removes an existing external connection from a repository. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisassociateExternalConnectionResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"486":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"domain","in":"query","required":true,"description":"The name of the domain that contains the repository from which to remove the external repository. ","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":"repository","in":"query","required":true,"description":"The name of the repository from which the external connection will be removed. ","schema":{"type":"string","pattern":"[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}","minLength":2,"maxLength":100}},{"name":"external-connection","in":"query","required":true,"description":"The name of the external connection to be removed from the repository. ","schema":{"type":"string","pattern":"[A-Za-z0-9][A-Za-z0-9._\\-:]{1,99}","minLength":2,"maxLength":100}}]}},"/v1/package/versions/copy#domain&source-repository&destination-repository&format&package":{"post":{"operationId":"CopyPackageVersions","description":"<p> Copies package versions from one repository to another repository in the same domain. </p> <note> <p> You must specify <code>versions</code> or <code>versionRevisions</code>. You cannot specify both. </p> </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyPackageVersionsResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"486":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"domain","in":"query","required":true,"description":" The name of the domain that contains the source and destination 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":"source-repository","in":"query","required":true,"description":" The name of the repository that contains the package versions to be copied. ","schema":{"type":"string","pattern":"[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}","minLength":2,"maxLength":100}},{"name":"destination-repository","in":"query","required":true,"description":" The name of the repository into which package versions are copied. ","schema":{"type":"string","pattern":"[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}","minLength":2,"maxLength":100}},{"name":"format","in":"query","required":true,"description":" The format of the package versions to be copied. ","schema":{"type":"string","enum":["npm","pypi","maven","nuget","generic"]}},{"name":"namespace","in":"query","required":false,"description":"<p>The namespace of the package versions to be copied. The package version component that specifies its namespace depends on its type. For example:</p> <ul> <li> <p> The namespace of a Maven package version is its <code>groupId</code>. The namespace is required when copying Maven package versions. </p> </li> <li> <p> The namespace of an npm package version is its <code>scope</code>. </p> </li> <li> <p> Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace. </p> </li> <li> <p> The namespace of a generic package is its <code>namespace</code>. </p> </li> </ul>","schema":{"type":"string","pattern":"[^#/\\s]+","minLength":1,"maxLength":255}},{"name":"package","in":"query","required":true,"description":" The name of the package that contains the versions to be copied. ","schema":{"type":"string","pattern":"[^#/\\s]+","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"versions":{"description":"<p> The versions of the package to be copied. </p> <note> <p> You must specify <code>versions</code> or <code>versionRevisions</code>. You cannot specify both. </p> </note>","type":"array","items":{"$ref":"#/components/schemas/PackageVersion"},"maxItems":100},"versionRevisions":{"description":"<p> A list of key-value pairs. The keys are package versions and the values are package version revisions. A <code>CopyPackageVersion</code> operation succeeds if the specified versions in the source repository match the specified package version revision. </p> <note> <p> You must specify <code>versions</code> or <code>versionRevisions</code>. You cannot specify both. </p> </note>","type":"object","additionalProperties":{"$ref":"#/components/schemas/PackageVersionRevision"}},"allowOverwrite":{"description":" Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the <code>failedVersions</code> field of the response with an <code>ALREADY_EXISTS</code> error code. ","type":"boolean"},"includeFromUpstream":{"description":" Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html\">Working with upstream repositories</a>. ","type":"boolean"}}}}}}},"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"}]},"/v1/domain#domain":{"post":{"operationId":"CreateDomain","description":"<p> Creates a domain. CodeArtifact <i>domains</i> make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different Amazon Web Services accounts. An asset is stored only once in a domain, even if it's in multiple repositories. </p> <p>Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration. </p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"486":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"domain","in":"query","required":true,"description":" The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable. ","schema":{"type":"string","pattern":"[a-z][a-z0-9\\-]{0,48}[a-z0-9]","minLength":2,"maxLength":50}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"encryptionKey":{"description":"<p> The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an <code>encryptionKey</code>, your IAM role must have <code>kms:DescribeKey</code> and <code>kms:CreateGrant</code> permissions on the encryption key that is used. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax\">DescribeKey</a> in the <i>Key Management Service API Reference</i> and <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\">Key Management Service API Permissions Reference</a> in the <i>Key Management Service Developer Guide</i>. </p> <important> <p> CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using symmetric and asymmetric keys</a> in the <i>Key Management Service Developer Guide</i>. </p> </important>","type":"string","pattern":"\\S+","minLength":1,"maxLength":1011},"tags":{"description":"One or more tag key-value pairs for the domain.","type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":0,"maxItems":200}}}}}}},"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":"DeleteDomain","description":" Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDomainResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"domain","in":"query","required":true,"description":" The name of the domain to delete. ","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}}]},"get":{"operationId":"DescribeDomain","description":" Returns a <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainDescription.html\">DomainDescription</a> object that contains information about the requested domain. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeDomainResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"domain","in":"query","required":true,"description":" A string that specifies the name of the requested domain. ","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}}]}},"/v1/repository#domain&repository":{"post":{"operationId":"CreateRepository","description":" Creates a repository. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRepositoryResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"486":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"domain","in":"query","required":true,"description":" The name of the domain that contains the created repository. ","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":"repository","in":"query","required":true,"description":" The name of the repository to create. ","schema":{"type":"string","pattern":"[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}","minLength":2,"maxLength":100}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"description":" A description of the created repository. ","type":"string","pattern":"\\P{C}*","maxLength":1000},"upstreams":{"description":" A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html\">Working with upstream repositories</a>. ","type":"array","items":{"$ref":"#/components/schemas/UpstreamRepository"}},"tags":{"description":"One or more tag key-value pairs for the repository.","type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":0,"maxItems":200}}}}}}},"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":"DeleteRepository","description":" Deletes a repository. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRepositoryResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"485":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"domain","in":"query","required":true,"description":" The name of the domain that contains the repository to delete. ","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":"repository","in":"query","required":true,"description":" The name of the repository to delete. ","schema":{"type":"string","pattern":"[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}","minLength":2,"maxLength":100}}]},"get":{"operationId":"DescribeRepository","description":" Returns a <code>RepositoryDescription</code> object that contains detailed information about the requested repository. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeRepositoryResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"domain","in":"query","required":true,"description":" The name of the domain that contains the repository to describe. ","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":"repository","in":"query","required":true,"description":" A string that specifies the name of the requested repository. ","schema":{"type":"string","pattern":"[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}","minLength":2,"maxLength":100}}]},"put":{"operationId":"UpdateRepository","description":" Update the properties of a repository. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRepositoryResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"486":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"domain","in":"query","required":true,"description":" The name of the domain associated with the repository to update. ","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":"repository","in":"query","required":true,"description":" The name of the repository to update. ","schema":{"type":"string","pattern":"[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}","minLength":2,"maxLength":100}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"description":" An updated repository description. ","type":"string","pattern":"\\P{C}*","maxLength":1000},"upstreams":{"description":" A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html\">Working with upstream repositories</a>. ","type":"array","items":{"$ref":"#/components/schemas/UpstreamRepository"}}}}}}}}},"/v1/domain/permissions/policy#domain":{"delete":{"operationId":"DeleteDomainPermissionsPolicy","description":" Deletes the resource policy set on a domain. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDomainPermissionsPolicyResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"485":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"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}}]},"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"}],"get":{"operationId":"GetDomainPermissionsPolicy","description":"<p> Returns the resource policy attached to the specified domain. </p> <note> <p> The policy is a resource-based policy, not an identity-based policy. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html\">Identity-based policies and resource-based policies </a> in the <i>IAM User Guide</i>. </p> </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDomainPermissionsPolicyResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"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}}]}},"/v1/package#domain&repository&format&package":{"delete":{"operationId":"DeletePackage","description":"Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DeletePackageVersions.html\">DeletePackageVersions</a> API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePackageResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"485":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"domain","in":"query","required":true,"description":"The name of the domain that contains the package to delete.","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":"repository","in":"query","required":true,"description":"The name of the repository that contains the package to delete.","schema":{"type":"string","pattern":"[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}","minLength":2,"maxLength":100}},{"name":"format","in":"query","required":true,"description":"The format of the requested package to delete.","schema":{"type":"string","enum":["npm","pypi","maven","nuget","generic"]}},{"name":"namespace","in":"query","required":false,"description":"<p>The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:</p> <ul> <li> <p> The namespace of a Maven package is its <code>groupId</code>. The namespace is required when deleting Maven package versions. </p> </li> <li> <p> The namespace of an npm package is its <code>scope</code>.</p> </li> <li> <p> Python and NuGet packages do not contain corresponding components, packages of those formats do not have a namespace. </p> </li> <li> <p> The namespace of a generic package is its <code>namespace</code>. </p> </li> </ul>","schema":{"type":"string","pattern":"[^#/\\s]+","minLength":1,"maxLength":255}},{"name":"package","in":"query","required":true,"description":"The name of the package to delete.","schema":{"type":"string","pattern":"[^#/\\s]+","minLength":1,"maxLength":255}}]},"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"}],"get":{"operationId":"DescribePackage","description":" Returns a <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html\">PackageDescription</a> object that contains information about the requested package.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribePackageResult"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"domain","in":"query","required":true,"description":"The name of the domain that contains the repository that contains the package.","schema":{"type":"string","pattern":"[a-z][a-z0-9\\-]{0,48}[a-z0-9]","minL