CodeArtifact 2018-09-22
- Client: Aws\CodeArtifact\CodeArtifactClient
- Service ID: codeartifact
- Version: 2018-09-22
This page describes the parameters and results for the operations of the CodeArtifact (2018-09-22), and shows how to use the Aws\CodeArtifact\CodeArtifactClient object to call the described operations. This documentation is specific to the 2018-09-22 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateExternalConnection ( array $params = [] )
Adds an existing external connection to a repository.
- CopyPackageVersions ( array $params = [] )
Copies package versions from one repository to another repository in the same domain.
- CreateDomain ( array $params = [] )
Creates a domain.
- CreateRepository ( array $params = [] )
Creates a repository.
- DeleteDomain ( array $params = [] )
Deletes a domain.
- DeleteDomainPermissionsPolicy ( array $params = [] )
Deletes the resource policy set on a domain.
- DeletePackage ( array $params = [] )
Deletes a package and all associated package versions.
- DeletePackageVersions ( array $params = [] )
Deletes one or more versions of a package.
- DeleteRepository ( array $params = [] )
Deletes a repository.
- DeleteRepositoryPermissionsPolicy ( array $params = [] )
Deletes the resource policy that is set on a repository.
- DescribeDomain ( array $params = [] )
Returns a DomainDescription object that contains information about the requested domain.
- DescribePackage ( array $params = [] )
Returns a PackageDescription object that contains information about the requested package.
- DescribePackageVersion ( array $params = [] )
Returns a PackageVersionDescription object that contains information about the requested package version.
- DescribeRepository ( array $params = [] )
Returns a RepositoryDescription object that contains detailed information about the requested repository.
- DisassociateExternalConnection ( array $params = [] )
Removes an existing external connection from a repository.
- DisposePackageVersions ( array $params = [] )
Deletes the assets in package versions and sets the package versions' status to Disposed.
- GetAuthorizationToken ( array $params = [] )
Generates a temporary authorization token for accessing repositories in the domain.
- GetDomainPermissionsPolicy ( array $params = [] )
Returns the resource policy attached to the specified domain.
- GetPackageVersionAsset ( array $params = [] )
Returns an asset (or file) that is in a package.
- GetPackageVersionReadme ( array $params = [] )
Gets the readme file or descriptive text for a package version.
- GetRepositoryEndpoint ( array $params = [] )
Returns the endpoint of a repository for a specific package format.
- GetRepositoryPermissionsPolicy ( array $params = [] )
Returns the resource policy that is set on a repository.
- ListDomains ( array $params = [] )
Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call.
- ListPackageVersionAssets ( array $params = [] )
Returns a list of AssetSummary objects for assets in a package version.
- ListPackageVersionDependencies ( array $params = [] )
Returns the direct dependencies for a package version.
- ListPackageVersions ( array $params = [] )
Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters.
- ListPackages ( array $params = [] )
Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
- ListRepositories ( array $params = [] )
Returns a list of RepositorySummary objects.
- ListRepositoriesInDomain ( array $params = [] )
Returns a list of RepositorySummary objects.
- ListTagsForResource ( array $params = [] )
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
- PublishPackageVersion ( array $params = [] )
Creates a new package version containing one or more assets (or files).
- PutDomainPermissionsPolicy ( array $params = [] )
Sets a resource policy on a domain that specifies permissions to access it.
- PutPackageOriginConfiguration ( array $params = [] )
Sets the package origin configuration for a package.
- PutRepositoryPermissionsPolicy ( array $params = [] )
Sets the resource policy on a repository that specifies permissions to access it.
- TagResource ( array $params = [] )
Adds or updates tags for a resource in CodeArtifact.
- UntagResource ( array $params = [] )
Removes tags from a resource in CodeArtifact.
- UpdatePackageVersionsStatus ( array $params = [] )
Updates the status of one or more versions of a package.
- UpdateRepository ( array $params = [] )
Update the properties of a repository.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateExternalConnection
$result = $client->associateExternalConnection([/* ... */]); $promise = $client->associateExternalConnectionAsync([/* ... */]);
Adds an existing external connection to a repository. One external connection is allowed per repository.
A repository can have one or more upstream repositories, or an external connection.
Parameter Syntax
$result = $client->associateExternalConnection([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'externalConnection' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- externalConnection
-
- Required: Yes
- Type: string
The name of the external connection to add to the repository. The following values are supported:
-
public:npmjs- for the npm public repository. -
public:nuget-org- for the NuGet Gallery. -
public:pypi- for the Python Package Index. -
public:maven-central- for Maven Central. -
public:maven-googleandroid- for the Google Android repository. -
public:maven-gradleplugins- for the Gradle plugins repository. -
public:maven-commonsware- for the CommonsWare Android repository. -
public:maven-clojars- for the Clojars repository.
- repository
-
- Required: Yes
- Type: string
The name of the repository to which the external connection is added.
Result Syntax
[
'repository' => [
'administratorAccount' => '<string>',
'arn' => '<string>',
'createdTime' => <DateTime>,
'description' => '<string>',
'domainName' => '<string>',
'domainOwner' => '<string>',
'externalConnections' => [
[
'externalConnectionName' => '<string>',
'packageFormat' => 'npm|pypi|maven|nuget|generic|swift',
'status' => 'Available',
],
// ...
],
'name' => '<string>',
'upstreams' => [
[
'repositoryName' => '<string>',
],
// ...
],
],
]
Result Details
Members
- repository
-
- Type: RepositoryDescription structure
Information about the connected repository after processing the request.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
ServiceQuotaExceededException:
The operation did not succeed because it would have exceeded a service limit for your account.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
CopyPackageVersions
$result = $client->copyPackageVersions([/* ... */]); $promise = $client->copyPackageVersionsAsync([/* ... */]);
Copies package versions from one repository to another repository in the same domain.
You must specify versions or versionRevisions. You cannot specify both.
Parameter Syntax
$result = $client->copyPackageVersions([
'allowOverwrite' => true || false,
'destinationRepository' => '<string>', // REQUIRED
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'includeFromUpstream' => true || false,
'namespace' => '<string>',
'package' => '<string>', // REQUIRED
'sourceRepository' => '<string>', // REQUIRED
'versionRevisions' => ['<string>', ...],
'versions' => ['<string>', ...],
]);
Parameter Details
Members
- allowOverwrite
-
- Type: boolean
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
failedVersionsfield of the response with anALREADY_EXISTSerror code. - destinationRepository
-
- Required: Yes
- Type: string
The name of the repository into which package versions are copied.
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the source and destination repositories.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- format
-
- Required: Yes
- Type: string
The format of the package versions to be copied.
- includeFromUpstream
-
- Type: boolean
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 Working with upstream repositories.
- namespace
-
- Type: string
The namespace of the package versions to be copied. The package version component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package version is its
groupId. The namespace is required when copying Maven package versions. -
The namespace of an npm package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- package
-
- Required: Yes
- Type: string
The name of the package that contains the versions to be copied.
- sourceRepository
-
- Required: Yes
- Type: string
The name of the repository that contains the package versions to be copied.
- versionRevisions
-
- Type: Associative array of custom strings keys (PackageVersion) to strings
A list of key-value pairs. The keys are package versions and the values are package version revisions. A
CopyPackageVersionoperation succeeds if the specified versions in the source repository match the specified package version revision.You must specify
versionsorversionRevisions. You cannot specify both. - versions
-
- Type: Array of strings
The versions of the package to be copied.
You must specify
versionsorversionRevisions. You cannot specify both.
Result Syntax
[
'failedVersions' => [
'<PackageVersion>' => [
'errorCode' => 'ALREADY_EXISTS|MISMATCHED_REVISION|MISMATCHED_STATUS|NOT_ALLOWED|NOT_FOUND|SKIPPED',
'errorMessage' => '<string>',
],
// ...
],
'successfulVersions' => [
'<PackageVersion>' => [
'revision' => '<string>',
'status' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted',
],
// ...
],
]
Result Details
Members
- failedVersions
-
- Type: Associative array of custom strings keys (PackageVersion) to PackageVersionError structures
A map of package versions that failed to copy and their error codes. The possible error codes are in the
PackageVersionErrordata type. They are:-
ALREADY_EXISTS -
MISMATCHED_REVISION -
MISMATCHED_STATUS -
NOT_ALLOWED -
NOT_FOUND -
SKIPPED
- successfulVersions
-
- Type: Associative array of custom strings keys (PackageVersion) to SuccessfulPackageVersionInfo structures
A list of the package versions that were successfully copied to your repository.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
ServiceQuotaExceededException:
The operation did not succeed because it would have exceeded a service limit for your account.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
CreateDomain
$result = $client->createDomain([/* ... */]); $promise = $client->createDomainAsync([/* ... */]);
Creates a domain. CodeArtifact domains 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.
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.
Parameter Syntax
$result = $client->createDomain([
'domain' => '<string>', // REQUIRED
'encryptionKey' => '<string>',
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
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.
- encryptionKey
-
- Type: string
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
encryptionKey, your IAM role must havekms:DescribeKeyandkms:CreateGrantpermissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key Management Service API Permissions Reference in the Key Management Service Developer Guide.CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.
- tags
-
- Type: Array of Tag structures
One or more tag key-value pairs for the domain.
Result Syntax
[
'domain' => [
'arn' => '<string>',
'assetSizeBytes' => <integer>,
'createdTime' => <DateTime>,
'encryptionKey' => '<string>',
'name' => '<string>',
'owner' => '<string>',
'repositoryCount' => <integer>,
's3BucketArn' => '<string>',
'status' => 'Active|Deleted',
],
]
Result Details
Members
- domain
-
- Type: DomainDescription structure
Contains information about the created domain after processing the request.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
ServiceQuotaExceededException:
The operation did not succeed because it would have exceeded a service limit for your account.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
CreateRepository
$result = $client->createRepository([/* ... */]); $promise = $client->createRepositoryAsync([/* ... */]);
Creates a repository.
Parameter Syntax
$result = $client->createRepository([
'description' => '<string>',
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'repository' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
'upstreams' => [
[
'repositoryName' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
A description of the created repository.
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the created repository.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- repository
-
- Required: Yes
- Type: string
The name of the repository to create.
- tags
-
- Type: Array of Tag structures
One or more tag key-value pairs for the repository.
- upstreams
-
- Type: Array of UpstreamRepository structures
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 Working with upstream repositories.
Result Syntax
[
'repository' => [
'administratorAccount' => '<string>',
'arn' => '<string>',
'createdTime' => <DateTime>,
'description' => '<string>',
'domainName' => '<string>',
'domainOwner' => '<string>',
'externalConnections' => [
[
'externalConnectionName' => '<string>',
'packageFormat' => 'npm|pypi|maven|nuget|generic|swift',
'status' => 'Available',
],
// ...
],
'name' => '<string>',
'upstreams' => [
[
'repositoryName' => '<string>',
],
// ...
],
],
]
Result Details
Members
- repository
-
- Type: RepositoryDescription structure
Information about the created repository after processing the request.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
ServiceQuotaExceededException:
The operation did not succeed because it would have exceeded a service limit for your account.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
DeleteDomain
$result = $client->deleteDomain([/* ... */]); $promise = $client->deleteDomainAsync([/* ... */]);
Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.
Parameter Syntax
$result = $client->deleteDomain([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain to delete.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Result Syntax
[
'domain' => [
'arn' => '<string>',
'assetSizeBytes' => <integer>,
'createdTime' => <DateTime>,
'encryptionKey' => '<string>',
'name' => '<string>',
'owner' => '<string>',
'repositoryCount' => <integer>,
's3BucketArn' => '<string>',
'status' => 'Active|Deleted',
],
]
Result Details
Members
- domain
-
- Type: DomainDescription structure
Contains information about the deleted domain after processing the request.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
DeleteDomainPermissionsPolicy
$result = $client->deleteDomainPermissionsPolicy([/* ... */]); $promise = $client->deleteDomainPermissionsPolicyAsync([/* ... */]);
Deletes the resource policy set on a domain.
Parameter Syntax
$result = $client->deleteDomainPermissionsPolicy([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'policyRevision' => '<string>',
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain associated with the resource policy to be deleted.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- policyRevision
-
- Type: string
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.
Result Syntax
[
'policy' => [
'document' => '<string>',
'resourceArn' => '<string>',
'revision' => '<string>',
],
]
Result Details
Members
- policy
-
- Type: ResourcePolicy structure
Information about the deleted resource policy after processing the request.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
DeletePackage
$result = $client->deletePackage([/* ... */]); $promise = $client->deletePackageAsync([/* ... */]);
Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions API.
Parameter Syntax
$result = $client->deletePackage([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'namespace' => '<string>',
'package' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the package to delete.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- format
-
- Required: Yes
- Type: string
The format of the requested package to delete.
- namespace
-
- Type: string
The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package is its
groupId. The namespace is required when deleting Maven package versions. -
The namespace of an npm package is its
scope. -
Python and NuGet packages do not contain corresponding components, packages of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- package
-
- Required: Yes
- Type: string
The name of the package to delete.
- repository
-
- Required: Yes
- Type: string
The name of the repository that contains the package to delete.
Result Syntax
[
'deletedPackage' => [
'format' => 'npm|pypi|maven|nuget|generic|swift',
'namespace' => '<string>',
'originConfiguration' => [
'restrictions' => [
'publish' => 'ALLOW|BLOCK',
'upstream' => 'ALLOW|BLOCK',
],
],
'package' => '<string>',
],
]
Result Details
Members
- deletedPackage
-
- Type: PackageSummary structure
Details about a package, including its format, namespace, and name.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
DeletePackageVersions
$result = $client->deletePackageVersions([/* ... */]); $promise = $client->deletePackageVersionsAsync([/* ... */]);
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 restore them using UpdatePackageVersionsStatus.
Parameter Syntax
$result = $client->deletePackageVersions([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'expectedStatus' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'namespace' => '<string>',
'package' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
'versions' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the package to delete.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- expectedStatus
-
- Type: string
The expected status of the package version to delete.
- format
-
- Required: Yes
- Type: string
The format of the package versions to delete.
- namespace
-
- Type: string
The namespace of the package versions to be deleted. The package version component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package version is its
groupId. The namespace is required when deleting Maven package versions. -
The namespace of an npm package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- package
-
- Required: Yes
- Type: string
The name of the package with the versions to delete.
- repository
-
- Required: Yes
- Type: string
The name of the repository that contains the package versions to delete.
- versions
-
- Required: Yes
- Type: Array of strings
An array of strings that specify the versions of the package to delete.
Result Syntax
[
'failedVersions' => [
'<PackageVersion>' => [
'errorCode' => 'ALREADY_EXISTS|MISMATCHED_REVISION|MISMATCHED_STATUS|NOT_ALLOWED|NOT_FOUND|SKIPPED',
'errorMessage' => '<string>',
],
// ...
],
'successfulVersions' => [
'<PackageVersion>' => [
'revision' => '<string>',
'status' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted',
],
// ...
],
]
Result Details
Members
- failedVersions
-
- Type: Associative array of custom strings keys (PackageVersion) to PackageVersionError structures
A
PackageVersionErrorobject that contains a map of errors codes for the deleted package that failed. The possible error codes are:-
ALREADY_EXISTS -
MISMATCHED_REVISION -
MISMATCHED_STATUS -
NOT_ALLOWED -
NOT_FOUND -
SKIPPED
- successfulVersions
-
- Type: Associative array of custom strings keys (PackageVersion) to SuccessfulPackageVersionInfo structures
A list of the package versions that were successfully deleted. The status of every successful version will be
Deleted.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
DeleteRepository
$result = $client->deleteRepository([/* ... */]); $promise = $client->deleteRepositoryAsync([/* ... */]);
Deletes a repository.
Parameter Syntax
$result = $client->deleteRepository([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository to delete.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- repository
-
- Required: Yes
- Type: string
The name of the repository to delete.
Result Syntax
[
'repository' => [
'administratorAccount' => '<string>',
'arn' => '<string>',
'createdTime' => <DateTime>,
'description' => '<string>',
'domainName' => '<string>',
'domainOwner' => '<string>',
'externalConnections' => [
[
'externalConnectionName' => '<string>',
'packageFormat' => 'npm|pypi|maven|nuget|generic|swift',
'status' => 'Available',
],
// ...
],
'name' => '<string>',
'upstreams' => [
[
'repositoryName' => '<string>',
],
// ...
],
],
]
Result Details
Members
- repository
-
- Type: RepositoryDescription structure
Information about the deleted repository after processing the request.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
DeleteRepositoryPermissionsPolicy
$result = $client->deleteRepositoryPermissionsPolicy([/* ... */]); $promise = $client->deleteRepositoryPermissionsPolicyAsync([/* ... */]);
Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate.
Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.
Parameter Syntax
$result = $client->deleteRepositoryPermissionsPolicy([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'policyRevision' => '<string>',
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository associated with the resource policy to be deleted.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- policyRevision
-
- Type: string
The revision of the repository's resource policy to be deleted. This revision is used for optimistic locking, which prevents others from accidentally overwriting your changes to the repository's resource policy.
- repository
-
- Required: Yes
- Type: string
The name of the repository that is associated with the resource policy to be deleted
Result Syntax
[
'policy' => [
'document' => '<string>',
'resourceArn' => '<string>',
'revision' => '<string>',
],
]
Result Details
Members
- policy
-
- Type: ResourcePolicy structure
Information about the deleted policy after processing the request.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
DescribeDomain
$result = $client->describeDomain([/* ... */]); $promise = $client->describeDomainAsync([/* ... */]);
Returns a DomainDescription object that contains information about the requested domain.
Parameter Syntax
$result = $client->describeDomain([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
A string that specifies the name of the requested domain.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Result Syntax
[
'domain' => [
'arn' => '<string>',
'assetSizeBytes' => <integer>,
'createdTime' => <DateTime>,
'encryptionKey' => '<string>',
'name' => '<string>',
'owner' => '<string>',
'repositoryCount' => <integer>,
's3BucketArn' => '<string>',
'status' => 'Active|Deleted',
],
]
Result Details
Members
- domain
-
- Type: DomainDescription structure
Information about a domain. A domain is a container for repositories. When you create a domain, it is empty until you add one or more repositories.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
DescribePackage
$result = $client->describePackage([/* ... */]); $promise = $client->describePackageAsync([/* ... */]);
Returns a PackageDescription object that contains information about the requested package.
Parameter Syntax
$result = $client->describePackage([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'namespace' => '<string>',
'package' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository that contains the package.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- format
-
- Required: Yes
- Type: string
A format that specifies the type of the requested package.
- namespace
-
- Type: string
The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package is its
groupId. The namespace is required when requesting Maven packages. -
The namespace of an npm package is its
scope. -
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- package
-
- Required: Yes
- Type: string
The name of the requested package.
- repository
-
- Required: Yes
- Type: string
The name of the repository that contains the requested package.
Result Syntax
[
'package' => [
'format' => 'npm|pypi|maven|nuget|generic|swift',
'name' => '<string>',
'namespace' => '<string>',
'originConfiguration' => [
'restrictions' => [
'publish' => 'ALLOW|BLOCK',
'upstream' => 'ALLOW|BLOCK',
],
],
],
]
Result Details
Members
- package
-
- Required: Yes
- Type: PackageDescription structure
A PackageDescription object that contains information about the requested package.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
DescribePackageVersion
$result = $client->describePackageVersion([/* ... */]); $promise = $client->describePackageVersionAsync([/* ... */]);
Returns a PackageVersionDescription object that contains information about the requested package version.
Parameter Syntax
$result = $client->describePackageVersion([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'namespace' => '<string>',
'package' => '<string>', // REQUIRED
'packageVersion' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository that contains the package version.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- format
-
- Required: Yes
- Type: string
A format that specifies the type of the requested package version.
- namespace
-
- Type: string
The namespace of the requested package version. The package version component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package version is its
groupId. -
The namespace of an npm package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- package
-
- Required: Yes
- Type: string
The name of the requested package version.
- packageVersion
-
- Required: Yes
- Type: string
A string that contains the package version (for example,
3.5.2). - repository
-
- Required: Yes
- Type: string
The name of the repository that contains the package version.
Result Syntax
[
'packageVersion' => [
'displayName' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift',
'homePage' => '<string>',
'licenses' => [
[
'name' => '<string>',
'url' => '<string>',
],
// ...
],
'namespace' => '<string>',
'origin' => [
'domainEntryPoint' => [
'externalConnectionName' => '<string>',
'repositoryName' => '<string>',
],
'originType' => 'INTERNAL|EXTERNAL|UNKNOWN',
],
'packageName' => '<string>',
'publishedTime' => <DateTime>,
'revision' => '<string>',
'sourceCodeRepository' => '<string>',
'status' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted',
'summary' => '<string>',
'version' => '<string>',
],
]
Result Details
Members
- packageVersion
-
- Required: Yes
- Type: PackageVersionDescription structure
A PackageVersionDescription object that contains information about the requested package version.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
DescribeRepository
$result = $client->describeRepository([/* ... */]); $promise = $client->describeRepositoryAsync([/* ... */]);
Returns a RepositoryDescription object that contains detailed information about the requested repository.
Parameter Syntax
$result = $client->describeRepository([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository to describe.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- repository
-
- Required: Yes
- Type: string
A string that specifies the name of the requested repository.
Result Syntax
[
'repository' => [
'administratorAccount' => '<string>',
'arn' => '<string>',
'createdTime' => <DateTime>,
'description' => '<string>',
'domainName' => '<string>',
'domainOwner' => '<string>',
'externalConnections' => [
[
'externalConnectionName' => '<string>',
'packageFormat' => 'npm|pypi|maven|nuget|generic|swift',
'status' => 'Available',
],
// ...
],
'name' => '<string>',
'upstreams' => [
[
'repositoryName' => '<string>',
],
// ...
],
],
]
Result Details
Members
- repository
-
- Type: RepositoryDescription structure
A
RepositoryDescriptionobject that contains the requested repository information.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
DisassociateExternalConnection
$result = $client->disassociateExternalConnection([/* ... */]); $promise = $client->disassociateExternalConnectionAsync([/* ... */]);
Removes an existing external connection from a repository.
Parameter Syntax
$result = $client->disassociateExternalConnection([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'externalConnection' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository from which to remove the external repository.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- externalConnection
-
- Required: Yes
- Type: string
The name of the external connection to be removed from the repository.
- repository
-
- Required: Yes
- Type: string
The name of the repository from which the external connection will be removed.
Result Syntax
[
'repository' => [
'administratorAccount' => '<string>',
'arn' => '<string>',
'createdTime' => <DateTime>,
'description' => '<string>',
'domainName' => '<string>',
'domainOwner' => '<string>',
'externalConnections' => [
[
'externalConnectionName' => '<string>',
'packageFormat' => 'npm|pypi|maven|nuget|generic|swift',
'status' => 'Available',
],
// ...
],
'name' => '<string>',
'upstreams' => [
[
'repositoryName' => '<string>',
],
// ...
],
],
]
Result Details
Members
- repository
-
- Type: RepositoryDescription structure
The repository associated with the removed external connection.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
ServiceQuotaExceededException:
The operation did not succeed because it would have exceeded a service limit for your account.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
DisposePackageVersions
$result = $client->disposePackageVersions([/* ... */]); $promise = $client->disposePackageVersionsAsync([/* ... */]);
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 status parameter to Disposed.
To view information about a disposed package version, use DescribePackageVersion.
Parameter Syntax
$result = $client->disposePackageVersions([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'expectedStatus' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'namespace' => '<string>',
'package' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
'versionRevisions' => ['<string>', ...],
'versions' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository you want to dispose.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- expectedStatus
-
- Type: string
The expected status of the package version to dispose.
- format
-
- Required: Yes
- Type: string
A format that specifies the type of package versions you want to dispose.
- namespace
-
- Type: string
The namespace of the package versions to be disposed. The package version component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package version is its
groupId. -
The namespace of an npm package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- package
-
- Required: Yes
- Type: string
The name of the package with the versions you want to dispose.
- repository
-
- Required: Yes
- Type: string
The name of the repository that contains the package versions you want to dispose.
- versionRevisions
-
- Type: Associative array of custom strings keys (PackageVersion) to strings
The revisions of the package versions you want to dispose.
- versions
-
- Required: Yes
- Type: Array of strings
The versions of the package you want to dispose.
Result Syntax
[
'failedVersions' => [
'<PackageVersion>' => [
'errorCode' => 'ALREADY_EXISTS|MISMATCHED_REVISION|MISMATCHED_STATUS|NOT_ALLOWED|NOT_FOUND|SKIPPED',
'errorMessage' => '<string>',
],
// ...
],
'successfulVersions' => [
'<PackageVersion>' => [
'revision' => '<string>',
'status' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted',
],
// ...
],
]
Result Details
Members
- failedVersions
-
- Type: Associative array of custom strings keys (PackageVersion) to PackageVersionError structures
A
PackageVersionErrorobject that contains a map of errors codes for the disposed package versions that failed. The possible error codes are:-
ALREADY_EXISTS -
MISMATCHED_REVISION -
MISMATCHED_STATUS -
NOT_ALLOWED -
NOT_FOUND -
SKIPPED
- successfulVersions
-
- Type: Associative array of custom strings keys (PackageVersion) to SuccessfulPackageVersionInfo structures
A list of the package versions that were successfully disposed.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
GetAuthorizationToken
$result = $client->getAuthorizationToken([/* ... */]); $promise = $client->getAuthorizationTokenAsync([/* ... */]);
Generates a temporary authorization token for accessing repositories in the domain. This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens.
CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. You can call login periodically to refresh the token. When you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds parameter.
The authorization period begins after login or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration.
See Using IAM Roles for more information on controlling session duration.
Parameter Syntax
$result = $client->getAuthorizationToken([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'durationSeconds' => <integer>,
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that is in scope for the generated authorization token.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- durationSeconds
-
- Type: long (int|float)
The time, in seconds, that the generated authorization token is valid. Valid values are
0and any number between900(15 minutes) and43200(12 hours). A value of0will set the expiration of the authorization token to the same expiration of the user's role's temporary credentials.
Result Syntax
[
'authorizationToken' => '<string>',
'expiration' => <DateTime>,
]
Result Details
Members
- authorizationToken
-
- Type: string
The returned authentication token.
- expiration
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that specifies the date and time the authorization token expires.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
GetDomainPermissionsPolicy
$result = $client->getDomainPermissionsPolicy([/* ... */]); $promise = $client->getDomainPermissionsPolicyAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getDomainPermissionsPolicy([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain to which the resource policy is attached.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Result Syntax
[
'policy' => [
'document' => '<string>',
'resourceArn' => '<string>',
'revision' => '<string>',
],
]
Result Details
Members
- policy
-
- Type: ResourcePolicy structure
The returned resource policy.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
GetPackageVersionAsset
$result = $client->getPackageVersionAsset([/* ... */]); $promise = $client->getPackageVersionAssetAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getPackageVersionAsset([
'asset' => '<string>', // REQUIRED
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'namespace' => '<string>',
'package' => '<string>', // REQUIRED
'packageVersion' => '<string>', // REQUIRED
'packageVersionRevision' => '<string>',
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- asset
-
- Required: Yes
- Type: string
The name of the requested asset.
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository that contains the package version with the requested asset.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- format
-
- Required: Yes
- Type: string
A format that specifies the type of the package version with the requested asset file.
- namespace
-
- Type: string
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:
-
The namespace of a Maven package version is its
groupId. -
The namespace of an npm package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- package
-
- Required: Yes
- Type: string
The name of the package that contains the requested asset.
- packageVersion
-
- Required: Yes
- Type: string
A string that contains the package version (for example,
3.5.2). - packageVersionRevision
-
- Type: string
The name of the package version revision that contains the requested asset.
- repository
-
- Required: Yes
- Type: string
The repository that contains the package version with the requested asset.
Result Syntax
[
'asset' => <string || resource || Psr\Http\Message\StreamInterface>,
'assetName' => '<string>',
'packageVersion' => '<string>',
'packageVersionRevision' => '<string>',
]
Result Details
Members
- asset
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The binary file, or asset, that is downloaded.
- assetName
-
- Type: string
The name of the asset that is downloaded.
- packageVersion
-
- Type: string
A string that contains the package version (for example,
3.5.2). - packageVersionRevision
-
- Type: string
The name of the package version revision that contains the downloaded asset.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
-
The operation did not succeed because prerequisites are not met.
GetPackageVersionReadme
$result = $client->getPackageVersionReadme([/* ... */]); $promise = $client->getPackageVersionReadmeAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getPackageVersionReadme([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'namespace' => '<string>',
'package' => '<string>', // REQUIRED
'packageVersion' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository that contains the package version with the requested readme file.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- format
-
- Required: Yes
- Type: string
A format that specifies the type of the package version with the requested readme file.
- namespace
-
- Type: string
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:
-
The namespace of an npm package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
- package
-
- Required: Yes
- Type: string
The name of the package version that contains the requested readme file.
- packageVersion
-
- Required: Yes
- Type: string
A string that contains the package version (for example,
3.5.2). - repository
-
- Required: Yes
- Type: string
The repository that contains the package with the requested readme file.
Result Syntax
[
'format' => 'npm|pypi|maven|nuget|generic|swift',
'namespace' => '<string>',
'package' => '<string>',
'readme' => '<string>',
'version' => '<string>',
'versionRevision' => '<string>',
]
Result Details
Members
- format
-
- Type: string
The format of the package with the requested readme file.
- namespace
-
- Type: string
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:
-
The namespace of a Maven package version is its
groupId. -
The namespace of an npm package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
- package
-
- Type: string
The name of the package that contains the returned readme file.
- readme
-
- Type: string
The text of the returned readme file.
- version
-
- Type: string
The version of the package with the requested readme file.
- versionRevision
-
- Type: string
The current revision associated with the package version.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
GetRepositoryEndpoint
$result = $client->getRepositoryEndpoint([/* ... */]); $promise = $client->getRepositoryEndpointAsync([/* ... */]);
Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
-
maven -
npm -
nuget -
pypi
Parameter Syntax
$result = $client->getRepositoryEndpoint([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.
- format
-
- Required: Yes
- Type: string
Returns which endpoint of a repository to return. A repository has one endpoint for each package format.
- repository
-
- Required: Yes
- Type: string
The name of the repository.
Result Syntax
[
'repositoryEndpoint' => '<string>',
]
Result Details
Members
- repositoryEndpoint
-
- Type: string
A string that specifies the URL of the returned endpoint.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
GetRepositoryPermissionsPolicy
$result = $client->getRepositoryPermissionsPolicy([/* ... */]); $promise = $client->getRepositoryPermissionsPolicyAsync([/* ... */]);
Returns the resource policy that is set on a repository.
Parameter Syntax
$result = $client->getRepositoryPermissionsPolicy([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain containing the repository whose associated resource policy is to be retrieved.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- repository
-
- Required: Yes
- Type: string
The name of the repository whose associated resource policy is to be retrieved.
Result Syntax
[
'policy' => [
'document' => '<string>',
'resourceArn' => '<string>',
'revision' => '<string>',
],
]
Result Details
Members
- policy
-
- Type: ResourcePolicy structure
The returned resource policy.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
ListDomains
$result = $client->listDomains([/* ... */]); $promise = $client->listDomainsAsync([/* ... */]);
Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call. Each returned DomainSummary object contains information about a domain.
Parameter Syntax
$result = $client->listDomains([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
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.
Result Syntax
[
'domains' => [
[
'arn' => '<string>',
'createdTime' => <DateTime>,
'encryptionKey' => '<string>',
'name' => '<string>',
'owner' => '<string>',
'status' => 'Active|Deleted',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- domains
-
- Type: Array of DomainSummary structures
The returned list of DomainSummary objects.
- nextToken
-
- Type: string
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.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
ListPackageVersionAssets
$result = $client->listPackageVersionAssets([/* ... */]); $promise = $client->listPackageVersionAssetsAsync([/* ... */]);
Returns a list of AssetSummary objects for assets in a package version.
Parameter Syntax
$result = $client->listPackageVersionAssets([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'maxResults' => <integer>,
'namespace' => '<string>',
'nextToken' => '<string>',
'package' => '<string>', // REQUIRED
'packageVersion' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository associated with the package version assets.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- format
-
- Required: Yes
- Type: string
The format of the package that contains the requested package version assets.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- namespace
-
- Type: string
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:
-
The namespace of a Maven package version is its
groupId. -
The namespace of an npm package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- nextToken
-
- Type: string
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.
- package
-
- Required: Yes
- Type: string
The name of the package that contains the requested package version assets.
- packageVersion
-
- Required: Yes
- Type: string
A string that contains the package version (for example,
3.5.2). - repository
-
- Required: Yes
- Type: string
The name of the repository that contains the package that contains the requested package version assets.
Result Syntax
[
'assets' => [
[
'hashes' => ['<string>', ...],
'name' => '<string>',
'size' => <integer>,
],
// ...
],
'format' => 'npm|pypi|maven|nuget|generic|swift',
'namespace' => '<string>',
'nextToken' => '<string>',
'package' => '<string>',
'version' => '<string>',
'versionRevision' => '<string>',
]
Result Details
Members
- assets
-
- Type: Array of AssetSummary structures
The returned list of AssetSummary objects.
- format
-
- Type: string
The format of the package that contains the requested package version assets.
- namespace
-
- Type: string
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:
-
The namespace of a Maven package version is its
groupId. -
The namespace of an npm package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
- package
-
- Type: string
The name of the package that contains the requested package version assets.
- version
-
- Type: string
The version of the package associated with the requested assets.
- versionRevision
-
- Type: string
The current revision associated with the package version.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
ListPackageVersionDependencies
$result = $client->listPackageVersionDependencies([/* ... */]); $promise = $client->listPackageVersionDependenciesAsync([/* ... */]);
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 configuration file are not returned.
Parameter Syntax
$result = $client->listPackageVersionDependencies([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'namespace' => '<string>',
'nextToken' => '<string>',
'package' => '<string>', // REQUIRED
'packageVersion' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository that contains the requested package version dependencies.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- format
-
- Required: Yes
- Type: string
The format of the package with the requested dependencies.
- namespace
-
- Type: string
The namespace of the package version with the requested dependencies. The package version component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package version is its
groupId. -
The namespace of an npm package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- nextToken
-
- Type: string
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.
- package
-
- Required: Yes
- Type: string
The name of the package versions' package.
- packageVersion
-
- Required: Yes
- Type: string
A string that contains the package version (for example,
3.5.2). - repository
-
- Required: Yes
- Type: string
The name of the repository that contains the requested package version.
Result Syntax
[
'dependencies' => [
[
'dependencyType' => '<string>',
'namespace' => '<string>',
'package' => '<string>',
'versionRequirement' => '<string>',
],
// ...
],
'format' => 'npm|pypi|maven|nuget|generic|swift',
'namespace' => '<string>',
'nextToken' => '<string>',
'package' => '<string>',
'version' => '<string>',
'versionRevision' => '<string>',
]
Result Details
Members
- dependencies
-
- Type: Array of PackageDependency structures
The returned list of PackageDependency objects.
- format
-
- Type: string
A format that specifies the type of the package that contains the returned dependencies.
- namespace
-
- Type: string
The namespace of the package version that contains the returned dependencies. The package version component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package version is its
groupId. -
The namespace of an npm package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
- nextToken
-
- Type: string
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.
- package
-
- Type: string
The name of the package that contains the returned package versions dependencies.
- version
-
- Type: string
The version of the package that is specified in the request.
- versionRevision
-
- Type: string
The current revision associated with the package version.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
ListPackageVersions
$result = $client->listPackageVersions([/* ... */]); $promise = $client->listPackageVersionsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listPackageVersions([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'maxResults' => <integer>,
'namespace' => '<string>',
'nextToken' => '<string>',
'originType' => 'INTERNAL|EXTERNAL|UNKNOWN',
'package' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
'sortBy' => 'PUBLISHED_TIME',
'status' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted',
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository that contains the requested package versions.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- format
-
- Required: Yes
- Type: string
The format of the package versions you want to list.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- namespace
-
- Type: string
The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package is its
groupId. -
The namespace of an npm package is its
scope. -
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- nextToken
-
- Type: string
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.
- originType
-
- Type: string
The
originTypeused to filter package versions. Only package versions with the providedoriginTypewill be returned. - package
-
- Required: Yes
- Type: string
The name of the package for which you want to request package versions.
- repository
-
- Required: Yes
- Type: string
The name of the repository that contains the requested package versions.
- sortBy
-
- Type: string
How to sort the requested list of package versions.
- status
-
- Type: string
A string that filters the requested package versions by status.
Result Syntax
[
'defaultDisplayVersion' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift',
'namespace' => '<string>',
'nextToken' => '<string>',
'package' => '<string>',
'versions' => [
[
'origin' => [
'domainEntryPoint' => [
'externalConnectionName' => '<string>',
'repositoryName' => '<string>',
],
'originType' => 'INTERNAL|EXTERNAL|UNKNOWN',
],
'revision' => '<string>',
'status' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted',
'version' => '<string>',
],
// ...
],
]
Result Details
Members
- defaultDisplayVersion
-
- Type: string
The default package version to display. This depends on the package format:
-
For Maven and PyPI packages, it's the most recently published package version.
-
For npm packages, it's the version referenced by the
latesttag. If thelatesttag is not set, it's the most recently published package version.
- format
-
- Type: string
A format of the package.
- namespace
-
- Type: string
The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package is its
groupId. -
The namespace of an npm package is its
scope. -
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
- package
-
- Type: string
The name of the package.
- versions
-
- Type: Array of PackageVersionSummary structures
The returned list of PackageVersionSummary objects.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
ListPackages
$result = $client->listPackages([/* ... */]); $promise = $client->listPackagesAsync([/* ... */]);
Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
Parameter Syntax
$result = $client->listPackages([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift',
'maxResults' => <integer>,
'namespace' => '<string>',
'nextToken' => '<string>',
'packagePrefix' => '<string>',
'publish' => 'ALLOW|BLOCK',
'repository' => '<string>', // REQUIRED
'upstream' => 'ALLOW|BLOCK',
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository that contains the requested packages.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- format
-
- Type: string
The format used to filter requested packages. Only packages from the provided format will be returned.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- namespace
-
- Type: string
The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called
--namespaceand not--namespace-prefix, it has prefix-matching behavior.Each package format uses namespace as follows:
-
The namespace of a Maven package is its
groupId. -
The namespace of an npm package is its
scope. -
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- nextToken
-
- Type: string
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.
- packagePrefix
-
- Type: string
A prefix used to filter requested packages. Only packages with names that start with
packagePrefixare returned. - publish
-
- Type: string
The value of the
Publishpackage origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions. - repository
-
- Required: Yes
- Type: string
The name of the repository that contains the requested packages.
- upstream
-
- Type: string
The value of the
Upstreampackage origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
Result Syntax
[
'nextToken' => '<string>',
'packages' => [
[
'format' => 'npm|pypi|maven|nuget|generic|swift',
'namespace' => '<string>',
'originConfiguration' => [
'restrictions' => [
'publish' => 'ALLOW|BLOCK',
'upstream' => 'ALLOW|BLOCK',
],
],
'package' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
- packages
-
- Type: Array of PackageSummary structures
The list of returned PackageSummary objects.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
ListRepositories
$result = $client->listRepositories([/* ... */]); $promise = $client->listRepositoriesAsync([/* ... */]);
Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified Amazon Web Services account and that matches the input parameters.
Parameter Syntax
$result = $client->listRepositories([
'maxResults' => <integer>,
'nextToken' => '<string>',
'repositoryPrefix' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
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.
- repositoryPrefix
-
- Type: string
A prefix used to filter returned repositories. Only repositories with names that start with
repositoryPrefixare returned.
Result Syntax
[
'nextToken' => '<string>',
'repositories' => [
[
'administratorAccount' => '<string>',
'arn' => '<string>',
'createdTime' => <DateTime>,
'description' => '<string>',
'domainName' => '<string>',
'domainOwner' => '<string>',
'name' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
- repositories
-
- Type: Array of RepositorySummary structures
The returned list of RepositorySummary objects.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
ListRepositoriesInDomain
$result = $client->listRepositoriesInDomain([/* ... */]); $promise = $client->listRepositoriesInDomainAsync([/* ... */]);
Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters.
Parameter Syntax
$result = $client->listRepositoriesInDomain([
'administratorAccount' => '<string>',
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
'repositoryPrefix' => '<string>',
]);
Parameter Details
Members
- administratorAccount
-
- Type: string
Filter the list of repositories to only include those that are managed by the Amazon Web Services account ID.
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the returned list of repositories.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
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.
- repositoryPrefix
-
- Type: string
A prefix used to filter returned repositories. Only repositories with names that start with
repositoryPrefixare returned.
Result Syntax
[
'nextToken' => '<string>',
'repositories' => [
[
'administratorAccount' => '<string>',
'arn' => '<string>',
'createdTime' => <DateTime>,
'description' => '<string>',
'domainName' => '<string>',
'domainOwner' => '<string>',
'name' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
- repositories
-
- Type: Array of RepositorySummary structures
The returned list of repositories.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to get tags for.
Result Syntax
[
'tags' => [
[
'key' => '<string>',
'value' => '<string>',
],
// ...
],
]
Result Details
Members
- tags
-
- Type: Array of Tag structures
A list of tag key and value pairs associated with the specified resource.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
PublishPackageVersion
$result = $client->publishPackageVersion([/* ... */]); $promise = $client->publishPackageVersionAsync([/* ... */]);
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 Published, omit the unfinished flag when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set to Published, it cannot change back to Unfinished.
Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide.
Parameter Syntax
$result = $client->publishPackageVersion([
'assetContent' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
'assetName' => '<string>', // REQUIRED
'assetSHA256' => '<string>', // REQUIRED
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'namespace' => '<string>',
'package' => '<string>', // REQUIRED
'packageVersion' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
'unfinished' => true || false,
]);
Parameter Details
Members
- assetContent
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The content of the asset to publish.
- assetName
-
- Required: Yes
- Type: string
The name of the asset to publish. Asset names can include Unicode letters and numbers, and the following special characters:
~ ! @ ^ & ( ) - ` _ + [ ] { } ; , . ` - assetSHA256
-
- Required: Yes
- Type: string
The SHA256 hash of the
assetContentto publish. This value must be calculated by the caller and provided with the request (see Publishing a generic package in the CodeArtifact User Guide).This value is used as an integrity check to verify that the
assetContenthas not changed after it was originally sent. - domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository that contains the package version to publish.
- domainOwner
-
- Type: string
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
- format
-
- Required: Yes
- Type: string
A format that specifies the type of the package version with the requested asset file.
The only supported value is
generic. - namespace
-
- Type: string
The namespace of the package version to publish.
- package
-
- Required: Yes
- Type: string
The name of the package version to publish.
- packageVersion
-
- Required: Yes
- Type: string
The package version to publish (for example,
3.5.2). - repository
-
- Required: Yes
- Type: string
The name of the repository that the package version will be published to.
- unfinished
-
- Type: boolean
Specifies whether the package version should remain in the
unfinishedstate. If omitted, the package version status will be set toPublished(see Package version status in the CodeArtifact User Guide).Valid values:
unfinished
Result Syntax
[
'asset' => [
'hashes' => ['<string>', ...],
'name' => '<string>',
'size' => <integer>,
],
'format' => 'npm|pypi|maven|nuget|generic|swift',
'namespace' => '<string>',
'package' => '<string>',
'status' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted',
'version' => '<string>',
'versionRevision' => '<string>',
]
Result Details
Members
- asset
-
- Type: AssetSummary structure
An AssetSummary for the published asset.
- format
-
- Type: string
The format of the package version.
- namespace
-
- Type: string
The namespace of the package version.
- package
-
- Type: string
The name of the package.
- status
-
- Type: string
A string that contains the status of the package version. For more information, see Package version status in the CodeArtifact User Guide.
- version
-
- Type: string
The version of the package.
- versionRevision
-
- Type: string
The revision of the package version.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
ServiceQuotaExceededException:
The operation did not succeed because it would have exceeded a service limit for your account.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
PutDomainPermissionsPolicy
$result = $client->putDomainPermissionsPolicy([/* ... */]); $promise = $client->putDomainPermissionsPolicyAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->putDomainPermissionsPolicy([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'policyDocument' => '<string>', // REQUIRED
'policyRevision' => '<string>',
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain on which to set the resource policy.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- policyDocument
-
- Required: Yes
- Type: string
A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.
- policyRevision
-
- Type: string
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.
Result Syntax
[
'policy' => [
'document' => '<string>',
'resourceArn' => '<string>',
'revision' => '<string>',
],
]
Result Details
Members
- policy
-
- Type: ResourcePolicy structure
The resource policy that was set after processing the request.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
ServiceQuotaExceededException:
The operation did not succeed because it would have exceeded a service limit for your account.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
PutPackageOriginConfiguration
$result = $client->putPackageOriginConfiguration([/* ... */]); $promise = $client->putPackageOriginConfigurationAsync([/* ... */]);
Sets the package origin configuration for a package.
The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide.
PutPackageOriginConfiguration can be called on a package that doesn't yet exist in the repository. When called on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.
Parameter Syntax
$result = $client->putPackageOriginConfiguration([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'namespace' => '<string>',
'package' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
'restrictions' => [ // REQUIRED
'publish' => 'ALLOW|BLOCK', // REQUIRED
'upstream' => 'ALLOW|BLOCK', // REQUIRED
],
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository that contains the package.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- format
-
- Required: Yes
- Type: string
A format that specifies the type of the package to be updated.
- namespace
-
- Type: string
The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package is its
groupId. -
The namespace of an npm package is its
scope. -
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- package
-
- Required: Yes
- Type: string
The name of the package to be updated.
- repository
-
- Required: Yes
- Type: string
The name of the repository that contains the package.
- restrictions
-
- Required: Yes
- Type: PackageOriginRestrictions structure
A PackageOriginRestrictions object that contains information about the
upstreamandpublishpackage origin restrictions. Theupstreamrestriction determines if new package versions can be ingested or retained from external connections or upstream repositories. Thepublishrestriction determines if new package versions can be published directly to the repository.You must include both the desired
upstreamandpublishrestrictions.
Result Syntax
[
'originConfiguration' => [
'restrictions' => [
'publish' => 'ALLOW|BLOCK',
'upstream' => 'ALLOW|BLOCK',
],
],
]
Result Details
Members
- originConfiguration
-
- Type: PackageOriginConfiguration structure
A PackageOriginConfiguration object that describes the origin configuration set for the package. It contains a PackageOriginRestrictions object that describes how new versions of the package can be introduced to the repository.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
PutRepositoryPermissionsPolicy
$result = $client->putRepositoryPermissionsPolicy([/* ... */]); $promise = $client->putRepositoryPermissionsPolicyAsync([/* ... */]);
Sets the resource policy on a repository that specifies permissions to access it.
When you call PutRepositoryPermissionsPolicy, the resource policy on the repository is ignored when evaluting permissions. This ensures that the owner of a repository cannot lock themselves out of the repository, which would prevent them from being able to update the resource policy.
Parameter Syntax
$result = $client->putRepositoryPermissionsPolicy([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'policyDocument' => '<string>', // REQUIRED
'policyRevision' => '<string>',
'repository' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain containing the repository to set the resource policy on.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- policyDocument
-
- Required: Yes
- Type: string
A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository.
- policyRevision
-
- Type: string
Sets the revision of the resource policy that specifies permissions to access the repository. This revision is used for optimistic locking, which prevents others from overwriting your changes to the repository's resource policy.
- repository
-
- Required: Yes
- Type: string
The name of the repository to set the resource policy on.
Result Syntax
[
'policy' => [
'document' => '<string>',
'resourceArn' => '<string>',
'revision' => '<string>',
],
]
Result Details
Members
- policy
-
- Type: ResourcePolicy structure
The resource policy that was set after processing the request.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
ServiceQuotaExceededException:
The operation did not succeed because it would have exceeded a service limit for your account.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds or updates tags for a resource in CodeArtifact.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => [ // REQUIRED
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.
- tags
-
- Required: Yes
- Type: Array of Tag structures
The tags you want to modify or add to the resource.
Result Syntax
[]
Result Details
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because the resource requested is not found in the service.
-
ServiceQuotaExceededException:
The operation did not succeed because it would have exceeded a service limit for your account.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes tags from a resource in CodeArtifact.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The tag key for each tag that you want to remove from the resource.
Result Syntax
[]
Result Details
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
UpdatePackageVersionsStatus
$result = $client->updatePackageVersionsStatus([/* ... */]); $promise = $client->updatePackageVersionsStatusAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updatePackageVersionsStatus([
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'expectedStatus' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted',
'format' => 'npm|pypi|maven|nuget|generic|swift', // REQUIRED
'namespace' => '<string>',
'package' => '<string>', // REQUIRED
'repository' => '<string>', // REQUIRED
'targetStatus' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted', // REQUIRED
'versionRevisions' => ['<string>', ...],
'versions' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- domain
-
- Required: Yes
- Type: string
The name of the domain that contains the repository that contains the package versions with a status to be updated.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- expectedStatus
-
- Type: string
The package version’s expected status before it is updated. If
expectedStatusis provided, the package version's status is updated only if its status at the timeUpdatePackageVersionsStatusis called matchesexpectedStatus. - format
-
- Required: Yes
- Type: string
A format that specifies the type of the package with the statuses to update.
- namespace
-
- Type: string
The namespace of the package version to be updated. The package version component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package version is its
groupId. -
The namespace of an npm package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- package
-
- Required: Yes
- Type: string
The name of the package with the version statuses to update.
- repository
-
- Required: Yes
- Type: string
The repository that contains the package versions with the status you want to update.
- targetStatus
-
- Required: Yes
- Type: string
The status you want to change the package version status to.
- versionRevisions
-
- Type: Associative array of custom strings keys (PackageVersion) to strings
A map of package versions and package version revisions. The map
keyis the package version (for example,3.5.2), and the mapvalueis the package version revision. - versions
-
- Required: Yes
- Type: Array of strings
An array of strings that specify the versions of the package with the statuses to update.
Result Syntax
[
'failedVersions' => [
'<PackageVersion>' => [
'errorCode' => 'ALREADY_EXISTS|MISMATCHED_REVISION|MISMATCHED_STATUS|NOT_ALLOWED|NOT_FOUND|SKIPPED',
'errorMessage' => '<string>',
],
// ...
],
'successfulVersions' => [
'<PackageVersion>' => [
'revision' => '<string>',
'status' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted',
],
// ...
],
]
Result Details
Members
- failedVersions
-
- Type: Associative array of custom strings keys (PackageVersion) to PackageVersionError structures
A list of
SuccessfulPackageVersionInfoobjects, one for each package version with a status that successfully updated. - successfulVersions
-
- Type: Associative array of custom strings keys (PackageVersion) to SuccessfulPackageVersionInfo structures
A list of
PackageVersionErrorobjects, one for each package version with a status that failed to update.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
UpdateRepository
$result = $client->updateRepository([/* ... */]); $promise = $client->updateRepositoryAsync([/* ... */]);
Update the properties of a repository.
Parameter Syntax
$result = $client->updateRepository([
'description' => '<string>',
'domain' => '<string>', // REQUIRED
'domainOwner' => '<string>',
'repository' => '<string>', // REQUIRED
'upstreams' => [
[
'repositoryName' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
An updated repository description.
- domain
-
- Required: Yes
- Type: string
The name of the domain associated with the repository to update.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- repository
-
- Required: Yes
- Type: string
The name of the repository to update.
- upstreams
-
- Type: Array of UpstreamRepository structures
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 Working with upstream repositories.
Result Syntax
[
'repository' => [
'administratorAccount' => '<string>',
'arn' => '<string>',
'createdTime' => <DateTime>,
'description' => '<string>',
'domainName' => '<string>',
'domainOwner' => '<string>',
'externalConnections' => [
[
'externalConnectionName' => '<string>',
'packageFormat' => 'npm|pypi|maven|nuget|generic|swift',
'status' => 'Available',
],
// ...
],
'name' => '<string>',
'upstreams' => [
[
'repositoryName' => '<string>',
],
// ...
],
],
]
Result Details
Members
- repository
-
- Type: RepositoryDescription structure
The updated repository.
Errors
-
The operation did not succeed because of an unauthorized access attempt.
-
The operation did not succeed because prerequisites are not met.
-
The operation did not succeed because of an error that occurred inside CodeArtifact.
-
The operation did not succeed because the resource requested is not found in the service.
-
ServiceQuotaExceededException:
The operation did not succeed because it would have exceeded a service limit for your account.
-
The operation did not succeed because too many requests are sent to the service.
-
The operation did not succeed because a parameter in the request was sent with an invalid value.
Shapes
AccessDeniedException
Description
The operation did not succeed because of an unauthorized access attempt.
Members
- message
-
- Required: Yes
- Type: string
AssetSummary
Description
Contains details about a package version asset.
Members
- hashes
-
- Type: Associative array of custom strings keys (HashAlgorithm) to strings
The hashes of the asset.
- name
-
- Required: Yes
- Type: string
The name of the asset.
- size
-
- Type: long (int|float)
The size of the asset.
ConflictException
Description
The operation did not succeed because prerequisites are not met.
Members
- message
-
- Required: Yes
- Type: string
- resourceId
-
- Type: string
The ID of the resource.
- resourceType
-
- Type: string
The type of Amazon Web Services resource.
DomainDescription
Description
Information about a domain. A domain is a container for repositories. When you create a domain, it is empty until you add one or more repositories.
Members
- arn
-
- Type: string
The Amazon Resource Name (ARN) of the domain.
- assetSizeBytes
-
- Type: long (int|float)
The total size of all assets in the domain.
- createdTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that represents the date and time the domain was created.
- encryptionKey
-
- Type: string
The ARN of an Key Management Service (KMS) key associated with a domain.
- name
-
- Type: string
The name of the domain.
- owner
-
- Type: string
The Amazon Web Services account ID that owns the domain.
- repositoryCount
-
- Type: int
The number of repositories in the domain.
- s3BucketArn
-
- Type: string
The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.
- status
-
- Type: string
The current status of a domain.
DomainEntryPoint
Description
Information about how a package originally entered the CodeArtifact domain. For packages published directly to CodeArtifact, the entry point is the repository it was published to. For packages ingested from an external repository, the entry point is the external connection that it was ingested from. An external connection is a CodeArtifact repository that is connected to an external repository such as the npm registry or NuGet gallery.
Members
- externalConnectionName
-
- Type: string
The name of the external connection that a package was ingested from.
- repositoryName
-
- Type: string
The name of the repository that a package was originally published to.
DomainSummary
Description
Information about a domain, including its name, Amazon Resource Name (ARN), and status. The ListDomains operation returns a list of DomainSummary objects.
Members
- arn
-
- Type: string
The ARN of the domain.
- createdTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that contains the date and time the domain was created.
- encryptionKey
-
- Type: string
The key used to encrypt the domain.
- name
-
- Type: string
The name of the domain.
- owner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- status
-
- Type: string
A string that contains the status of the domain.
InternalServerException
Description
The operation did not succeed because of an error that occurred inside CodeArtifact.
Members
- message
-
- Required: Yes
- Type: string
LicenseInfo
Description
Details of the license data.
Members
- name
-
- Type: string
Name of the license.
- url
-
- Type: string
The URL for license data.
PackageDependency
Description
Details about a package dependency.
Members
- dependencyType
-
- Type: string
The type of a package dependency. The possible values depend on the package type.
-
npm:
regular,dev,peer,optional -
maven:
optional,parent,compile,runtime,test,system,provided.Note that
parentis not a regular Maven dependency type; instead this is extracted from the<parent>element if one is defined in the package version's POM file. -
nuget: The
dependencyTypefield is never set for NuGet packages. -
pypi:
Requires-Dist
- namespace
-
- Type: string
The namespace of the package that this package depends on. The package component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package is its
groupId. -
The namespace of an npm package is its
scope. -
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
- package
-
- Type: string
The name of the package that this package depends on.
- versionRequirement
-
- Type: string
The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions:
1.2.3,^2.3.4, or4.x.
PackageDescription
Description
Details about a package.
Members
- format
-
- Type: string
A format that specifies the type of the package.
- name
-
- Type: string
The name of the package.
- namespace
-
- Type: string
The namespace of the package. The package component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package is its
groupId. -
The namespace of an npm package is its
scope. -
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- originConfiguration
-
- Type: PackageOriginConfiguration structure
The package origin configuration for the package.
PackageOriginConfiguration
Description
Details about the package origin configuration of a package.
Members
- restrictions
-
- Type: PackageOriginRestrictions structure
A
PackageOriginRestrictionsobject that contains information about the upstream and publish package origin configuration for the package.
PackageOriginRestrictions
Description
Details about the origin restrictions set on the package. The package origin restrictions determine how new versions of a package can be added to a specific repository.
Members
- publish
-
- Required: Yes
- Type: string
The package origin configuration that determines if new versions of the package can be published directly to the repository.
- upstream
-
- Required: Yes
- Type: string
The package origin configuration that determines if new versions of the package can be added to the repository from an external connection or upstream source.
PackageSummary
Description
Details about a package, including its format, namespace, and name.
Members
- format
-
- Type: string
The format of the package.
- namespace
-
- Type: string
The namespace of the package. The package component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package is its
groupId. -
The namespace of an npm package is its
scope. -
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- originConfiguration
-
- Type: PackageOriginConfiguration structure
A PackageOriginConfiguration object that contains a PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions.
- package
-
- Type: string
The name of the package.
PackageVersionDescription
Description
Details about a package version.
Members
- displayName
-
- Type: string
The name of the package that is displayed. The
displayNamevaries depending on the package version's format. For example, if an npm package is namedui, is in the namespacevue, and has the formatnpm, then thedisplayNameis@vue/ui. - format
-
- Type: string
The format of the package version.
- homePage
-
- Type: string
The homepage associated with the package.
- licenses
-
- Type: Array of LicenseInfo structures
Information about licenses associated with the package version.
- namespace
-
- Type: string
The namespace of the package version. The package version component that specifies its namespace depends on its type. For example:
-
The namespace of a Maven package version is its
groupId. -
The namespace of an npm package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- origin
-
- Type: PackageVersionOrigin structure
A PackageVersionOrigin object that contains information about how the package version was added to the repository.
- packageName
-
- Type: string
The name of the requested package.
- publishedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that contains the date and time the package version was published.
- revision
-
- Type: string
The revision of the package version.
- sourceCodeRepository
-
- Type: string
The repository for the source code in the package version, or the source code used to build it.
- status
-
- Type: string
A string that contains the status of the package version.
- summary
-
- Type: string
A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.
- version
-
- Type: string
The version of the package.
PackageVersionError
Description
l An error associated with package.
Members
- errorCode
-
- Type: string
The error code associated with the error. Valid error codes are:
-
ALREADY_EXISTS -
MISMATCHED_REVISION -
MISMATCHED_STATUS -
NOT_ALLOWED -
NOT_FOUND -
SKIPPED
- errorMessage
-
- Type: string
The error message associated with the error.
PackageVersionOrigin
Description
Information about how a package version was added to a repository.
Members
- domainEntryPoint
-
- Type: DomainEntryPoint structure
A DomainEntryPoint object that contains information about from which repository or external connection the package version was added to the domain.
- originType
-
- Type: string
Describes how the package version was originally added to the domain. An
INTERNALorigin type means the package version was published directly to a repository in the domain. AnEXTERNALorigin type means the package version was ingested from an external connection.
PackageVersionSummary
Description
Details about a package version, including its status, version, and revision. The ListPackageVersions operation returns a list of PackageVersionSummary objects.
Members
- origin
-
- Type: PackageVersionOrigin structure
A PackageVersionOrigin object that contains information about how the package version was added to the repository.
- revision
-
- Type: string
The revision associated with a package version.
- status
-
- Required: Yes
- Type: string
A string that contains the status of the package version. It can be one of the following:
- version
-
- Required: Yes
- Type: string
Information about a package version.
RepositoryDescription
Description
The details of a repository stored in CodeArtifact. A CodeArtifact repository contains a set of package versions, each of which maps to a set of assets. Repositories are polyglot—a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the npm CLI, the Maven CLI (mvn), and pip. You can create up to 100 repositories per Amazon Web Services account.
Members
- administratorAccount
-
- Type: string
The 12-digit account number of the Amazon Web Services account that manages the repository.
- arn
-
- Type: string
The Amazon Resource Name (ARN) of the repository.
- createdTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that represents the date and time the repository was created.
- description
-
- Type: string
A text description of the repository.
- domainName
-
- Type: string
The name of the domain that contains the repository.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.
- externalConnections
-
- Type: Array of RepositoryExternalConnectionInfo structures
An array of external connections associated with the repository.
- name
-
- Type: string
The name of the repository.
- upstreams
-
- Type: Array of UpstreamRepositoryInfo structures
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 Working with upstream repositories.
RepositoryExternalConnectionInfo
Description
Contains information about the external connection of a repository.
Members
- externalConnectionName
-
- Type: string
The name of the external connection associated with a repository.
- packageFormat
-
- Type: string
The package format associated with a repository's external connection. The valid package formats are:
-
npm: A Node Package Manager (npm) package. -
pypi: A Python Package Index (PyPI) package. -
maven: A Maven package that contains compiled code in a distributable format, such as a JAR file. -
nuget: A NuGet package.
- status
-
- Type: string
The status of the external connection of a repository. There is one valid value,
Available.
RepositorySummary
Description
Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The ListRepositories operation returns a list of RepositorySummary objects.
Members
- administratorAccount
-
- Type: string
The Amazon Web Services account ID that manages the repository.
- arn
-
- Type: string
The ARN of the repository.
- createdTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that represents the date and time the repository was created.
- description
-
- Type: string
The description of the repository.
- domainName
-
- Type: string
The name of the domain that contains the repository.
- domainOwner
-
- Type: string
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- name
-
- Type: string
The name of the repository.
ResourceNotFoundException
Description
The operation did not succeed because the resource requested is not found in the service.
Members
- message
-
- Required: Yes
- Type: string
- resourceId
-
- Type: string
The ID of the resource.
- resourceType
-
- Type: string
The type of Amazon Web Services resource.
ResourcePolicy
Description
An CodeArtifact resource policy that contains a resource ARN, document details, and a revision.
Members
- document
-
- Type: string
The resource policy formatted in JSON.
- resourceArn
-
- Type: string
The ARN of the resource associated with the resource policy
- revision
-
- Type: string
The current revision of the resource policy.
ServiceQuotaExceededException
Description
The operation did not succeed because it would have exceeded a service limit for your account.
Members
- message
-
- Required: Yes
- Type: string
- resourceId
-
- Type: string
The ID of the resource.
- resourceType
-
- Type: string
The type of Amazon Web Services resource.
SuccessfulPackageVersionInfo
Description
Contains the revision and status of a package version.
Members
- revision
-
- Type: string
The revision of a package version.
- status
-
- Type: string
The status of a package version.
Tag
Description
A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.
Members
- key
-
- Required: Yes
- Type: string
The tag key.
- value
-
- Required: Yes
- Type: string
The tag value.
ThrottlingException
Description
The operation did not succeed because too many requests are sent to the service.
Members
- message
-
- Required: Yes
- Type: string
- retryAfterSeconds
-
- Type: int
The time period, in seconds, to wait before retrying the request.
UpstreamRepository
Description
Information about an upstream repository. A list of UpstreamRepository objects is an input parameter to CreateRepository and UpdateRepository.
Members
- repositoryName
-
- Required: Yes
- Type: string
The name of an upstream repository.
UpstreamRepositoryInfo
Description
Information about an upstream repository.
Members
- repositoryName
-
- Type: string
The name of an upstream repository.
ValidationException
Description
The operation did not succeed because a parameter in the request was sent with an invalid value.
Members
- message
-
- Required: Yes
- Type: string
- reason
-
- Type: string