{ "opencollection": "1.0.0", "info": { "name": "CodeArtifact Authorization Token#domain Package API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Package", "type": "folder" }, "items": [ { "info": { "name": "Amazon CodeArtifact Copy Package Versions", "type": "http" }, "http": { "method": "POST", "url": "http://codeartifact.{region}.amazonaws.com/v1/package/versions/copy#domain&source-repository&destination-repository&format&package", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "query", "description": " The name of the domain that contains the source and destination repositories. " }, { "name": "domain-owner", "value": "", "type": "query", "description": " The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. " }, { "name": "source-repository", "value": "", "type": "query", "description": " The name of the repository that contains the package versions to be copied. " }, { "name": "destination-repository", "value": "", "type": "query", "description": " The name of the repository into which package versions are copied. " }, { "name": "format", "value": "", "type": "query", "description": " The format of the package versions to be copied. " }, { "name": "namespace", "value": "", "type": "query", "description": "

The namespace of the package versions to be copied. The package version component that specifies its namespace depends on its type. For example:

" }, { "name": "package", "value": "", "type": "query", "description": " The name of the package that contains the versions to be copied. " } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Copies package versions from one repository to another repository in the same domain.

You must specify versions or versionRevisions. You cannot specify both.

" }, { "info": { "name": "Amazon CodeArtifact Delete Package Versions", "type": "http" }, "http": { "method": "POST", "url": "http://codeartifact.{region}.amazonaws.com/v1/package/versions/delete#domain&repository&format&package", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "query", "description": " The name of the domain that contains the package to delete. " }, { "name": "domain-owner", "value": "", "type": "query", "description": " The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. " }, { "name": "repository", "value": "", "type": "query", "description": " The name of the repository that contains the package versions to delete. " }, { "name": "format", "value": "", "type": "query", "description": " The format of the package versions to delete. " }, { "name": "namespace", "value": "", "type": "query", "description": "

The namespace of the package versions to be deleted. The package version component that specifies its namespace depends on its type. For example:

" }, { "name": "package", "value": "", "type": "query", "description": " The name of the package with the versions to delete. " } ], "body": { "type": "json", "data": "{}" } }, "docs": " Deletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to Archived. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, ListPackageVersions), but you can restor" }, { "info": { "name": "Amazon CodeArtifact Describe Package Version", "type": "http" }, "http": { "method": "GET", "url": "http://codeartifact.{region}.amazonaws.com/v1/package/version#domain&repository&format&package&version", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "query", "description": " The name of the domain that contains the repository that contains the package version. " }, { "name": "domain-owner", "value": "", "type": "query", "description": " The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. " }, { "name": "repository", "value": "", "type": "query", "description": " The name of the repository that contains the package version. " }, { "name": "format", "value": "", "type": "query", "description": " A format that specifies the type of the requested package version. " }, { "name": "namespace", "value": "", "type": "query", "description": "

The namespace of the requested package version. The package version component that specifies its namespace depends on its type. For example:

" }, { "name": "package", "value": "", "type": "query", "description": " The name of the requested package version. " }, { "name": "version", "value": "", "type": "query", "description": " A string that contains the package version (for example, 3.5.2). " } ] }, "docs": " Returns a PackageVersionDescription object that contains information about the requested package version. " }, { "info": { "name": "Amazon CodeArtifact Dispose Package Versions", "type": "http" }, "http": { "method": "POST", "url": "http://codeartifact.{region}.amazonaws.com/v1/package/versions/dispose#domain&repository&format&package", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "query", "description": " The name of the domain that contains the repository you want to dispose. " }, { "name": "domain-owner", "value": "", "type": "query", "description": " The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. " }, { "name": "repository", "value": "", "type": "query", "description": " The name of the repository that contains the package versions you want to dispose. " }, { "name": "format", "value": "", "type": "query", "description": " A format that specifies the type of package versions you want to dispose. " }, { "name": "namespace", "value": "", "type": "query", "description": "

The namespace of the package versions to be disposed. The package version component that specifies its namespace depends on its type. For example:

" }, { "name": "package", "value": "", "type": "query", "description": " The name of the package with the versions you want to dispose. " } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Deletes the assets in package versions and sets the package versions' status to Disposed. A disposed package version cannot be restored in your repository because its assets are deleted.

To view all disposed package versions in a repository, use ListPackageVersions and set the The namespace of the package version with the requested asset file. The package version component that specifies its namespace depends on its type. For example:

" }, { "name": "package", "value": "", "type": "query", "description": " The name of the package that contains the requested asset. " }, { "name": "version", "value": "", "type": "query", "description": " A string that contains the package version (for example, 3.5.2). " }, { "name": "asset", "value": "", "type": "query", "description": " The name of the requested asset. " }, { "name": "revision", "value": "", "type": "query", "description": " The name of the package version revision that contains the requested asset. " } ] }, "docs": " Returns an asset (or file) that is in a package. For example, for a Maven package version, use GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version. " }, { "info": { "name": "Amazon CodeArtifact Get Package Version Readme", "type": "http" }, "http": { "method": "GET", "url": "http://codeartifact.{region}.amazonaws.com/v1/package/version/readme#domain&repository&format&package&version", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "query", "description": " The name of the domain that contains the repository that contains the package version with the requested readme file. " }, { "name": "domain-owner", "value": "", "type": "query", "description": " The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. " }, { "name": "repository", "value": "", "type": "query", "description": " The repository that contains the package with the requested readme file. " }, { "name": "format", "value": "", "type": "query", "description": " A format that specifies the type of the package version with the requested readme file. " }, { "name": "namespace", "value": "", "type": "query", "description": "

The namespace of the package version with the requested readme file. The package version component that specifies its namespace depends on its type. For example:

" }, { "name": "package", "value": "", "type": "query", "description": " The name of the package version that contains the requested readme file. " }, { "name": "version", "value": "", "type": "query", "description": " A string that contains the package version (for example, 3.5.2). " } ] }, "docs": "

Gets the readme file or descriptive text for a package version.

The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.

" }, { "info": { "name": "Amazon CodeArtifact List Package Version Assets", "type": "http" }, "http": { "method": "POST", "url": "http://codeartifact.{region}.amazonaws.com/v1/package/version/assets#domain&repository&format&package&version", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "query", "description": " The name of the domain that contains the repository associated with the package version assets. " }, { "name": "domain-owner", "value": "", "type": "query", "description": " The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. " }, { "name": "repository", "value": "", "type": "query", "description": " The name of the repository that contains the package that contains the requested package version assets. " }, { "name": "format", "value": "", "type": "query", "description": " The format of the package that contains the requested package version assets. " }, { "name": "namespace", "value": "", "type": "query", "description": "

The namespace of the package version that contains the requested package version assets. The package version component that specifies its namespace depends on its type. For example:

" }, { "name": "package", "value": "", "type": "query", "description": " The name of the package that contains the requested package version assets. " }, { "name": "version", "value": "", "type": "query", "description": " A string that contains the package version (for example, 3.5.2). " }, { "name": "max-results", "value": "", "type": "query", "description": " The maximum number of results to return per page. " }, { "name": "next-token", "value": "", "type": "query", "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. " }, { "name": "maxResults", "value": "", "type": "query", "description": "Pagination limit" }, { "name": "nextToken", "value": "", "type": "query", "description": "Pagination token" } ] }, "docs": " Returns a list of
AssetSummary objects for assets in a package version. " }, { "info": { "name": "Amazon CodeArtifact List Package Version Dependencies", "type": "http" }, "http": { "method": "POST", "url": "http://codeartifact.{region}.amazonaws.com/v1/package/version/dependencies#domain&repository&format&package&version", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "query", "description": " The name of the domain that contains the repository that contains the requested package version dependencies. " }, { "name": "domain-owner", "value": "", "type": "query", "description": " The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. " }, { "name": "repository", "value": "", "type": "query", "description": " The name of the repository that contains the requested package version. " }, { "name": "format", "value": "", "type": "query", "description": " The format of the package with the requested dependencies. " }, { "name": "namespace", "value": "", "type": "query", "description": "

The namespace of the package version with the requested dependencies. The package version component that specifies its namespace depends on its type. For example:

" }, { "name": "package", "value": "", "type": "query", "description": " The name of the package versions' package. " }, { "name": "version", "value": "", "type": "query", "description": " A string that contains the package version (for example, 3.5.2). " }, { "name": "next-token", "value": "", "type": "query", "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. " } ] }, "docs": " Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the package.json file for npm packages and the pom.xml file for Maven). Any package version dependencies that are not listed in the con" }, { "info": { "name": "Amazon CodeArtifact List Package Versions", "type": "http" }, "http": { "method": "POST", "url": "http://codeartifact.{region}.amazonaws.com/v1/package/versions#domain&repository&format&package", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "query", "description": " The name of the domain that contains the repository that contains the requested package versions. " }, { "name": "domain-owner", "value": "", "type": "query", "description": " The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. " }, { "name": "repository", "value": "", "type": "query", "description": " The name of the repository that contains the requested package versions. " }, { "name": "format", "value": "", "type": "query", "description": " The format of the package versions you want to list. " }, { "name": "namespace", "value": "", "type": "query", "description": "

The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

" }, { "name": "package", "value": "", "type": "query", "description": " The name of the package for which you want to request package versions. " }, { "name": "status", "value": "", "type": "query", "description": " A string that filters the requested package versions by status. " }, { "name": "sortBy", "value": "", "type": "query", "description": " How to sort the requested list of package versions. " }, { "name": "max-results", "value": "", "type": "query", "description": " The maximum number of results to return per page. " }, { "name": "next-token", "value": "", "type": "query", "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. " }, { "name": "originType", "value": "", "type": "query", "description": "The originType used to filter package versions. Only package versions with the provided originType will be returned." }, { "name": "maxResults", "value": "", "type": "query", "description": "Pagination limit" }, { "name": "nextToken", "value": "", "type": "query", "description": "Pagination token" } ] }, "docs": " Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters. Package versions of all statuses will be returned by default when calling list-package-versions with no --status parameter. " }, { "info": { "name": "Amazon CodeArtifact Publish Package Version", "type": "http" }, "http": { "method": "POST", "url": "http://codeartifact.{region}.amazonaws.com/v1/package/version/publish#domain&repository&format&package&version&asset&x-amz-content-sha256", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" }, { "name": "x-amz-content-sha256", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "query", "description": "The name of the domain that contains the repository that contains the package version to publish." }, { "name": "domain-owner", "value": "", "type": "query", "description": "The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces." }, { "name": "repository", "value": "", "type": "query", "description": "The name of the repository that the package version will be published to." }, { "name": "format", "value": "", "type": "query", "description": "

A format that specifies the type of the package version with the requested asset file.

The only supported value is generic.

" }, { "name": "namespace", "value": "", "type": "query", "description": "The namespace of the package version to publish." }, { "name": "package", "value": "", "type": "query", "description": "The name of the package version to publish." }, { "name": "version", "value": "", "type": "query", "description": "The package version to publish (for example, 3.5.2)." }, { "name": "asset", "value": "", "type": "query", "description": "The name of the asset to publish. Asset names can include Unicode letters and numbers, and the following special characters: ~ ! @ ^ & ( ) - ` _ + [ ] { } ; , . ` " }, { "name": "unfinished", "value": "", "type": "query", "description": "

Specifies whether the package version should remain in the unfinished state. If omitted, the package version status will be set to Published (see Package version status in the CodeArtifact User Guide).

Valid values: unfinished

" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Creates a new package version containing one or more assets (or files).

The unfinished flag can be used to keep the package version in the Unfinished state until all of its assets have been uploaded (see Package version status in the CodeArtifact user guide). To set the package version’s status to PublishedThe namespace of the package version to be updated. The package version component that specifies its namespace depends on its type. For example:

" }, { "name": "package", "value": "", "type": "query", "description": " The name of the package with the version statuses to update. " } ], "body": { "type": "json", "data": "{}" } }, "docs": " Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, you can update the status of package versions to Archived, Published, or Unlisted. To set the status of a package version to Disposed, use DisposePackageVersions. " } ] } ], "bundled": true }