AssociateExternalConnection

$result = $client->associateExternalConnection([/* ... */]);
$promise = $client->associateExternalConnectionAsync([/* ... */]);

Adds an existing external connection to a repository. One external connection is allowed per repository.

Parameter Syntax

$result = $client->associateExternalConnection([
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'externalConnection' => '<string>', // REQUIRED
    'repository' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'repository' => [
        'administratorAccount' => '<string>',
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'domainName' => '<string>',
        'domainOwner' => '<string>',
        'externalConnections' => [
            [
                'externalConnectionName' => '<string>',
                'packageFormat' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
                'status' => 'Available',
            ],
            // ...
        ],
        'name' => '<string>',
        'upstreams' => [
            [
                'repositoryName' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

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.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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.

Parameter Syntax

$result = $client->copyPackageVersions([
    'allowOverwrite' => true || false,
    'destinationRepository' => '<string>', // REQUIRED
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'format' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo', // REQUIRED
    'includeFromUpstream' => true || false,
    'namespace' => '<string>',
    'package' => '<string>', // REQUIRED
    'sourceRepository' => '<string>', // REQUIRED
    'versionRevisions' => ['<string>', ...],
    'versions' => ['<string>', ...],
]);

Parameter Details

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

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

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.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[
    'domain' => [
        'arn' => '<string>',
        'assetSizeBytes' => <integer>,
        'createdTime' => <DateTime>,
        'encryptionKey' => '<string>',
        'name' => '<string>',
        'owner' => '<string>',
        'repositoryCount' => <integer>,
        's3BucketArn' => '<string>',
        'status' => 'Active|Deleted',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

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.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

CreatePackageGroup

$result = $client->createPackageGroup([/* ... */]);
$promise = $client->createPackageGroupAsync([/* ... */]);

Creates a package group. For more information about creating package groups, including example CLI commands, see Create a package group in the CodeArtifact User Guide.

Parameter Syntax

$result = $client->createPackageGroup([
    'contactInfo' => '<string>',
    'description' => '<string>',
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'packageGroup' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'packageGroup' => [
        'arn' => '<string>',
        'contactInfo' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'domainName' => '<string>',
        'domainOwner' => '<string>',
        'originConfiguration' => [
            'restrictions' => [
                '<PackageGroupOriginRestrictionType>' => [
                    'effectiveMode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                    'inheritedFrom' => [
                        'arn' => '<string>',
                        'pattern' => '<string>',
                    ],
                    'mode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                    'repositoriesCount' => <integer>,
                ],
                // ...
            ],
        ],
        'parent' => [
            'arn' => '<string>',
            'pattern' => '<string>',
        ],
        'pattern' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ServiceQuotaExceededException:

The operation did not succeed because it would have exceeded a service limit for your account.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

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

Result Syntax

[
    'repository' => [
        'administratorAccount' => '<string>',
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'domainName' => '<string>',
        'domainOwner' => '<string>',
        'externalConnections' => [
            [
                'externalConnectionName' => '<string>',
                'packageFormat' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
                'status' => 'Available',
            ],
            // ...
        ],
        'name' => '<string>',
        'upstreams' => [
            [
                'repositoryName' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

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.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[
    'domain' => [
        'arn' => '<string>',
        'assetSizeBytes' => <integer>,
        'createdTime' => <DateTime>,
        'encryptionKey' => '<string>',
        'name' => '<string>',
        'owner' => '<string>',
        'repositoryCount' => <integer>,
        's3BucketArn' => '<string>',
        'status' => 'Active|Deleted',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[
    'policy' => [
        'document' => '<string>',
        'resourceArn' => '<string>',
        'revision' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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|ruby|swift|cargo', // REQUIRED
    'namespace' => '<string>',
    'package' => '<string>', // REQUIRED
    'repository' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deletedPackage' => [
        'format' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
        'namespace' => '<string>',
        'originConfiguration' => [
            'restrictions' => [
                'publish' => 'ALLOW|BLOCK',
                'upstream' => 'ALLOW|BLOCK',
            ],
        ],
        'package' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

DeletePackageGroup

$result = $client->deletePackageGroup([/* ... */]);
$promise = $client->deletePackageGroupAsync([/* ... */]);

Deletes a package group. Deleting a package group does not delete packages or package versions associated with the package group. When a package group is deleted, the direct child package groups will become children of the package group's direct parent package group. Therefore, if any of the child groups are inheriting any settings from the parent, those settings could change.

Parameter Syntax

$result = $client->deletePackageGroup([
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'packageGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'packageGroup' => [
        'arn' => '<string>',
        'contactInfo' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'domainName' => '<string>',
        'domainOwner' => '<string>',
        'originConfiguration' => [
            'restrictions' => [
                '<PackageGroupOriginRestrictionType>' => [
                    'effectiveMode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                    'inheritedFrom' => [
                        'arn' => '<string>',
                        'pattern' => '<string>',
                    ],
                    'mode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                    'repositoriesCount' => <integer>,
                ],
                // ...
            ],
        ],
        'parent' => [
            'arn' => '<string>',
            'pattern' => '<string>',
        ],
        'pattern' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ServiceQuotaExceededException:

The operation did not succeed because it would have exceeded a service limit for your account.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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|ruby|swift|cargo', // REQUIRED
    'namespace' => '<string>',
    'package' => '<string>', // REQUIRED
    'repository' => '<string>', // REQUIRED
    'versions' => ['<string>', ...], // REQUIRED
]);

Parameter Details

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

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[
    'repository' => [
        'administratorAccount' => '<string>',
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'domainName' => '<string>',
        'domainOwner' => '<string>',
        'externalConnections' => [
            [
                'externalConnectionName' => '<string>',
                'packageFormat' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
                'status' => 'Available',
            ],
            // ...
        ],
        'name' => '<string>',
        'upstreams' => [
            [
                'repositoryName' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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.

Parameter Syntax

$result = $client->deleteRepositoryPermissionsPolicy([
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'policyRevision' => '<string>',
    'repository' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policy' => [
        'document' => '<string>',
        'resourceArn' => '<string>',
        'revision' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[
    'domain' => [
        'arn' => '<string>',
        'assetSizeBytes' => <integer>,
        'createdTime' => <DateTime>,
        'encryptionKey' => '<string>',
        'name' => '<string>',
        'owner' => '<string>',
        'repositoryCount' => <integer>,
        's3BucketArn' => '<string>',
        'status' => 'Active|Deleted',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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|ruby|swift|cargo', // REQUIRED
    'namespace' => '<string>',
    'package' => '<string>', // REQUIRED
    'repository' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'package' => [
        'format' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
        'name' => '<string>',
        'namespace' => '<string>',
        'originConfiguration' => [
            'restrictions' => [
                'publish' => 'ALLOW|BLOCK',
                'upstream' => 'ALLOW|BLOCK',
            ],
        ],
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

DescribePackageGroup

$result = $client->describePackageGroup([/* ... */]);
$promise = $client->describePackageGroupAsync([/* ... */]);

Returns a PackageGroupDescription object that contains information about the requested package group.

Parameter Syntax

$result = $client->describePackageGroup([
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'packageGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'packageGroup' => [
        'arn' => '<string>',
        'contactInfo' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'domainName' => '<string>',
        'domainOwner' => '<string>',
        'originConfiguration' => [
            'restrictions' => [
                '<PackageGroupOriginRestrictionType>' => [
                    'effectiveMode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                    'inheritedFrom' => [
                        'arn' => '<string>',
                        'pattern' => '<string>',
                    ],
                    'mode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                    'repositoriesCount' => <integer>,
                ],
                // ...
            ],
        ],
        'parent' => [
            'arn' => '<string>',
            'pattern' => '<string>',
        ],
        'pattern' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

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|ruby|swift|cargo', // REQUIRED
    'namespace' => '<string>',
    'package' => '<string>', // REQUIRED
    'packageVersion' => '<string>', // REQUIRED
    'repository' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'packageVersion' => [
        'displayName' => '<string>',
        'format' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
        '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

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[
    'repository' => [
        'administratorAccount' => '<string>',
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'domainName' => '<string>',
        'domainOwner' => '<string>',
        'externalConnections' => [
            [
                'externalConnectionName' => '<string>',
                'packageFormat' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
                'status' => 'Available',
            ],
            // ...
        ],
        'name' => '<string>',
        'upstreams' => [
            [
                'repositoryName' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[
    'repository' => [
        'administratorAccount' => '<string>',
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'domainName' => '<string>',
        'domainOwner' => '<string>',
        'externalConnections' => [
            [
                'externalConnectionName' => '<string>',
                'packageFormat' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
                'status' => 'Available',
            ],
            // ...
        ],
        'name' => '<string>',
        'upstreams' => [
            [
                'repositoryName' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

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.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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|ruby|swift|cargo', // REQUIRED
    'namespace' => '<string>',
    'package' => '<string>', // REQUIRED
    'repository' => '<string>', // REQUIRED
    'versionRevisions' => ['<string>', ...],
    'versions' => ['<string>', ...], // REQUIRED
]);

Parameter Details

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

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

GetAssociatedPackageGroup

$result = $client->getAssociatedPackageGroup([/* ... */]);
$promise = $client->getAssociatedPackageGroupAsync([/* ... */]);

Returns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such, GetAssociatedPackageGroup can be used to see which package group's origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them.

For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

Parameter Syntax

$result = $client->getAssociatedPackageGroup([
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'format' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo', // REQUIRED
    'namespace' => '<string>',
    'package' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'associationType' => 'STRONG|WEAK',
    'packageGroup' => [
        'arn' => '<string>',
        'contactInfo' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'domainName' => '<string>',
        'domainOwner' => '<string>',
        'originConfiguration' => [
            'restrictions' => [
                '<PackageGroupOriginRestrictionType>' => [
                    'effectiveMode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                    'inheritedFrom' => [
                        'arn' => '<string>',
                        'pattern' => '<string>',
                    ],
                    'mode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                    'repositoriesCount' => <integer>,
                ],
                // ...
            ],
        ],
        'parent' => [
            'arn' => '<string>',
            'pattern' => '<string>',
        ],
        'pattern' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

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.

Parameter Syntax

$result = $client->getAuthorizationToken([
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'durationSeconds' => <integer>,
]);

Parameter Details

Result Syntax

[
    'authorizationToken' => '<string>',
    'expiration' => <DateTime>,
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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.

Parameter Syntax

$result = $client->getDomainPermissionsPolicy([
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
]);

Parameter Details

Result Syntax

[
    'policy' => [
        'document' => '<string>',
        'resourceArn' => '<string>',
        'revision' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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|ruby|swift|cargo', // REQUIRED
    'namespace' => '<string>',
    'package' => '<string>', // REQUIRED
    'packageVersion' => '<string>', // REQUIRED
    'packageVersionRevision' => '<string>',
    'repository' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'asset' => <string || resource || Psr\Http\Message\StreamInterface>,
    'assetName' => '<string>',
    'packageVersion' => '<string>',
    'packageVersionRevision' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

ConflictException:

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|ruby|swift|cargo', // REQUIRED
    'namespace' => '<string>',
    'package' => '<string>', // REQUIRED
    'packageVersion' => '<string>', // REQUIRED
    'repository' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'format' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
    'namespace' => '<string>',
    'package' => '<string>',
    'readme' => '<string>',
    'version' => '<string>',
    'versionRevision' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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:

• cargo

• generic

• maven

• npm

• nuget

• pypi

• ruby

• swift

Parameter Syntax

$result = $client->getRepositoryEndpoint([
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'format' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo', // REQUIRED
    'repository' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'repositoryEndpoint' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[
    'policy' => [
        'document' => '<string>',
        'resourceArn' => '<string>',
        'revision' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

ListAllowedRepositoriesForGroup

$result = $client->listAllowedRepositoriesForGroup([/* ... */]);
$promise = $client->listAllowedRepositoriesForGroupAsync([/* ... */]);

Lists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see Package group origin controls in the CodeArtifact User Guide.

Parameter Syntax

$result = $client->listAllowedRepositoriesForGroup([
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'originRestrictionType' => 'EXTERNAL_UPSTREAM|INTERNAL_UPSTREAM|PUBLISH', // REQUIRED
    'packageGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'allowedRepositories' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ServiceQuotaExceededException:

The operation did not succeed because it would have exceeded a service limit for your account.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ListAssociatedPackages

$result = $client->listAssociatedPackages([/* ... */]);
$promise = $client->listAssociatedPackagesAsync([/* ... */]);

Returns a list of packages associated with the requested package group. For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

Parameter Syntax

$result = $client->listAssociatedPackages([
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'packageGroup' => '<string>', // REQUIRED
    'preview' => true || false,
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'packages' => [
        [
            'associationType' => 'STRONG|WEAK',
            'format' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
            'namespace' => '<string>',
            'package' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

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

Result Syntax

[
    'domains' => [
        [
            'arn' => '<string>',
            'createdTime' => <DateTime>,
            'encryptionKey' => '<string>',
            'name' => '<string>',
            'owner' => '<string>',
            'status' => 'Active|Deleted',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

ListPackageGroups

$result = $client->listPackageGroups([/* ... */]);
$promise = $client->listPackageGroupsAsync([/* ... */]);

Returns a list of package groups in the requested domain.

Parameter Syntax

$result = $client->listPackageGroups([
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'prefix' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'packageGroups' => [
        [
            'arn' => '<string>',
            'contactInfo' => '<string>',
            'createdTime' => <DateTime>,
            'description' => '<string>',
            'domainName' => '<string>',
            'domainOwner' => '<string>',
            'originConfiguration' => [
                'restrictions' => [
                    '<PackageGroupOriginRestrictionType>' => [
                        'effectiveMode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                        'inheritedFrom' => [
                            'arn' => '<string>',
                            'pattern' => '<string>',
                        ],
                        'mode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                        'repositoriesCount' => <integer>,
                    ],
                    // ...
                ],
            ],
            'parent' => [
                'arn' => '<string>',
                'pattern' => '<string>',
            ],
            'pattern' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

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|ruby|swift|cargo', // REQUIRED
    'maxResults' => <integer>,
    'namespace' => '<string>',
    'nextToken' => '<string>',
    'package' => '<string>', // REQUIRED
    'packageVersion' => '<string>', // REQUIRED
    'repository' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'assets' => [
        [
            'hashes' => ['<string>', ...],
            'name' => '<string>',
            'size' => <integer>,
        ],
        // ...
    ],
    'format' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
    'namespace' => '<string>',
    'nextToken' => '<string>',
    'package' => '<string>',
    'version' => '<string>',
    'versionRevision' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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|ruby|swift|cargo', // REQUIRED
    'namespace' => '<string>',
    'nextToken' => '<string>',
    'package' => '<string>', // REQUIRED
    'packageVersion' => '<string>', // REQUIRED
    'repository' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'dependencies' => [
        [
            'dependencyType' => '<string>',
            'namespace' => '<string>',
            'package' => '<string>',
            'versionRequirement' => '<string>',
        ],
        // ...
    ],
    'format' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
    'namespace' => '<string>',
    'nextToken' => '<string>',
    'package' => '<string>',
    'version' => '<string>',
    'versionRevision' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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|ruby|swift|cargo', // 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

Result Syntax

[
    'defaultDisplayVersion' => '<string>',
    'format' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
    '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

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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|ruby|swift|cargo',
    'maxResults' => <integer>,
    'namespace' => '<string>',
    'nextToken' => '<string>',
    'packagePrefix' => '<string>',
    'publish' => 'ALLOW|BLOCK',
    'repository' => '<string>', // REQUIRED
    'upstream' => 'ALLOW|BLOCK',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'packages' => [
        [
            'format' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
            'namespace' => '<string>',
            'originConfiguration' => [
                'restrictions' => [
                    'publish' => 'ALLOW|BLOCK',
                    'upstream' => 'ALLOW|BLOCK',
                ],
            ],
            'package' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'repositories' => [
        [
            'administratorAccount' => '<string>',
            'arn' => '<string>',
            'createdTime' => <DateTime>,
            'description' => '<string>',
            'domainName' => '<string>',
            'domainOwner' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'repositories' => [
        [
            'administratorAccount' => '<string>',
            'arn' => '<string>',
            'createdTime' => <DateTime>,
            'description' => '<string>',
            'domainName' => '<string>',
            'domainOwner' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

ListSubPackageGroups

$result = $client->listSubPackageGroups([/* ... */]);
$promise = $client->listSubPackageGroupsAsync([/* ... */]);

Returns a list of direct children of the specified package group.

For information package group hierarchy, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

Parameter Syntax

$result = $client->listSubPackageGroups([
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'packageGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'packageGroups' => [
        [
            'arn' => '<string>',
            'contactInfo' => '<string>',
            'createdTime' => <DateTime>,
            'description' => '<string>',
            'domainName' => '<string>',
            'domainOwner' => '<string>',
            'originConfiguration' => [
                'restrictions' => [
                    '<PackageGroupOriginRestrictionType>' => [
                        'effectiveMode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                        'inheritedFrom' => [
                            'arn' => '<string>',
                            'pattern' => '<string>',
                        ],
                        'mode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                        'repositoriesCount' => <integer>,
                    ],
                    // ...
                ],
            ],
            'parent' => [
                'arn' => '<string>',
                'pattern' => '<string>',
            ],
            'pattern' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

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

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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.

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|ruby|swift|cargo', // REQUIRED
    'namespace' => '<string>',
    'package' => '<string>', // REQUIRED
    'packageVersion' => '<string>', // REQUIRED
    'repository' => '<string>', // REQUIRED
    'unfinished' => true || false,
]);

Parameter Details

Result Syntax

[
    'asset' => [
        'hashes' => ['<string>', ...],
        'name' => '<string>',
        'size' => <integer>,
    ],
    'format' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
    'namespace' => '<string>',
    'package' => '<string>',
    'status' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted',
    'version' => '<string>',
    'versionRevision' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

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.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[
    'policy' => [
        'document' => '<string>',
        'resourceArn' => '<string>',
        'revision' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

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.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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|ruby|swift|cargo', // REQUIRED
    'namespace' => '<string>',
    'package' => '<string>', // REQUIRED
    'repository' => '<string>', // REQUIRED
    'restrictions' => [ // REQUIRED
        'publish' => 'ALLOW|BLOCK', // REQUIRED
        'upstream' => 'ALLOW|BLOCK', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'originConfiguration' => [
        'restrictions' => [
            'publish' => 'ALLOW|BLOCK',
            'upstream' => 'ALLOW|BLOCK',
        ],
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[
    'policy' => [
        'document' => '<string>',
        'resourceArn' => '<string>',
        'revision' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

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.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ResourceNotFoundException:

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.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

UpdatePackageGroup

$result = $client->updatePackageGroup([/* ... */]);
$promise = $client->updatePackageGroupAsync([/* ... */]);

Updates a package group. This API cannot be used to update a package group's origin configuration or pattern. To update a package group's origin configuration, use UpdatePackageGroupOriginConfiguration.

Parameter Syntax

$result = $client->updatePackageGroup([
    'contactInfo' => '<string>',
    'description' => '<string>',
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'packageGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'packageGroup' => [
        'arn' => '<string>',
        'contactInfo' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'domainName' => '<string>',
        'domainOwner' => '<string>',
        'originConfiguration' => [
            'restrictions' => [
                '<PackageGroupOriginRestrictionType>' => [
                    'effectiveMode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                    'inheritedFrom' => [
                        'arn' => '<string>',
                        'pattern' => '<string>',
                    ],
                    'mode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                    'repositoriesCount' => <integer>,
                ],
                // ...
            ],
        ],
        'parent' => [
            'arn' => '<string>',
            'pattern' => '<string>',
        ],
        'pattern' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ServiceQuotaExceededException:

The operation did not succeed because it would have exceeded a service limit for your account.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

UpdatePackageGroupOriginConfiguration

$result = $client->updatePackageGroupOriginConfiguration([/* ... */]);
$promise = $client->updatePackageGroupOriginConfigurationAsync([/* ... */]);

Updates the package origin configuration for a package group.

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 group origin controls and configuration, see Package group origin controls in the CodeArtifact User Guide.

Parameter Syntax

$result = $client->updatePackageGroupOriginConfiguration([
    'addAllowedRepositories' => [
        [
            'originRestrictionType' => 'EXTERNAL_UPSTREAM|INTERNAL_UPSTREAM|PUBLISH',
            'repositoryName' => '<string>',
        ],
        // ...
    ],
    'domain' => '<string>', // REQUIRED
    'domainOwner' => '<string>',
    'packageGroup' => '<string>', // REQUIRED
    'removeAllowedRepositories' => [
        [
            'originRestrictionType' => 'EXTERNAL_UPSTREAM|INTERNAL_UPSTREAM|PUBLISH',
            'repositoryName' => '<string>',
        ],
        // ...
    ],
    'restrictions' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'allowedRepositoryUpdates' => [
        '<PackageGroupOriginRestrictionType>' => [
            '<PackageGroupAllowedRepositoryUpdateType>' => ['<string>', ...],
            // ...
        ],
        // ...
    ],
    'packageGroup' => [
        'arn' => '<string>',
        'contactInfo' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'domainName' => '<string>',
        'domainOwner' => '<string>',
        'originConfiguration' => [
            'restrictions' => [
                '<PackageGroupOriginRestrictionType>' => [
                    'effectiveMode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                    'inheritedFrom' => [
                        'arn' => '<string>',
                        'pattern' => '<string>',
                    ],
                    'mode' => 'ALLOW|ALLOW_SPECIFIC_REPOSITORIES|BLOCK|INHERIT',
                    'repositoriesCount' => <integer>,
                ],
                // ...
            ],
        ],
        'parent' => [
            'arn' => '<string>',
            'pattern' => '<string>',
        ],
        'pattern' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ServiceQuotaExceededException:

The operation did not succeed because it would have exceeded a service limit for your account.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

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|ruby|swift|cargo', // REQUIRED
    'namespace' => '<string>',
    'package' => '<string>', // REQUIRED
    'repository' => '<string>', // REQUIRED
    'targetStatus' => 'Published|Unfinished|Unlisted|Archived|Disposed|Deleted', // REQUIRED
    'versionRevisions' => ['<string>', ...],
    'versions' => ['<string>', ...], // REQUIRED
]);

Parameter Details

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

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

The operation did not succeed because the resource requested is not found in the service.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

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

Result Syntax

[
    'repository' => [
        'administratorAccount' => '<string>',
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'domainName' => '<string>',
        'domainOwner' => '<string>',
        'externalConnections' => [
            [
                'externalConnectionName' => '<string>',
                'packageFormat' => 'npm|pypi|maven|nuget|generic|ruby|swift|cargo',
                'status' => 'Available',
            ],
            // ...
        ],
        'name' => '<string>',
        'upstreams' => [
            [
                'repositoryName' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

AccessDeniedException:

The operation did not succeed because of an unauthorized access attempt.

ConflictException:

The operation did not succeed because prerequisites are not met.

InternalServerException:

The operation did not succeed because of an error that occurred inside CodeArtifact.

ResourceNotFoundException:

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.

ThrottlingException:

The operation did not succeed because too many requests are sent to the service.

ValidationException:

The operation did not succeed because a parameter in the request was sent with an invalid value.