CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.
CodeArtifact Components
Use the information in this guide to help you work with the following CodeArtifact components:
Repository: A CodeArtifact repository contains a set of package versions, each of which maps to a set of assets, or files. Repositories are polyglot, so a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the npm CLI, the Maven CLI ( mvn ), Python CLIs ( pip and twine), and NuGet CLIs (nuget and dotnet).
Domain: Repositories are aggregated into a higher-level entity known as a domain. All package assets and metadata are stored in the domain, but are consumed through repositories. A given package asset, such as a Maven JAR file, is stored once per domain, no matter how many repositories it\'s present in. All of the assets and metadata in a domain are encrypted with the same customer master key (CMK) stored in Key Management Service (KMS).
Each repository is a member of a single domain and can\'t be moved to a different domain.
The domain allows organizational policy to be applied across multiple repositories, such as which accounts can access repositories in the domain, and which public repositories can be used as sources of packages.
Although an organization can have multiple domains, we recommend a single production domain that contains all published artifacts so that teams can find and share packages across their organization.
Package: A package is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, and NuGet package formats.
In CodeArtifact, a package consists of:
A name (for example, webpack is the name of a popular npm package)
An optional namespace (for example, @types in @types/node)
A set of versions (for example, 1.0.0, 1.0.1, 1.0.2, etc.)
Package-level metadata (for example, npm tags)
Package version: A version of a package, such as @types/node 12.6.9. The version number format and semantics vary for different package formats. For example, npm package versions must conform to the Semantic Versioning specification. In CodeArtifact, a package version consists of the version identifier, metadata at the package version level, and a set of assets.
Upstream repository: One repository is upstream of another when the package versions in it can be accessed from the repository endpoint of the downstream repository, effectively merging the contents of the two repositories from the point of view of a client. CodeArtifact allows creating an upstream relationship between two repositories.
Asset: An individual file stored in CodeArtifact associated with a package version, such as an npm .tgz file or Maven POM and JAR files.
CodeArtifact supports these operations:
AssociateExternalConnection: Adds an existing external connection to a repository.
CopyPackageVersions: Copies package versions from one repository to another repository in the same domain.
CreateDomain: Creates a domain
CreateRepository: Creates a CodeArtifact repository in a domain.
DeleteDomain: Deletes a domain. You cannot delete a domain that contains repositories.
DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a domain.
DeletePackage: Deletes a package and all associated package versions.
DeletePackageVersions: Deletes versions of a package. After a package has been deleted, it can be republished, but its assets and metadata cannot be restored because they have been permanently removed from storage.
DeleteRepository: Deletes a repository.
DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.
DescribeDomain: Returns a DomainDescription object that contains information about the requested domain.
DescribePackage: Returns a PackageDescription object that contains details about a package.
DescribePackageVersion: Returns a PackageVersionDescription object that contains details about a package version.
DescribeRepository: Returns a RepositoryDescription object that contains detailed information about the requested repository.
DisposePackageVersions: Disposes versions of a package. A package version with the status Disposed cannot be restored because they have been permanently removed from storage.
DisassociateExternalConnection: Removes an existing external connection from a repository.
GetAuthorizationToken: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.
GetDomainPermissionsPolicy: Returns the policy of a resource that is attached to the specified domain.
GetPackageVersionAsset: Returns the contents of an asset that is in a package version.
GetPackageVersionReadme: Gets the readme file or descriptive text for a package version.
GetRepositoryEndpoint: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
maven
npm
nuget
pypi
GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a repository.
ListDomains: Returns a list of DomainSummary objects. Each returned DomainSummary object contains information about a domain.
ListPackages: Lists the packages in a repository.
ListPackageVersionAssets: Lists the assets for a given package version.
ListPackageVersionDependencies: Returns a list of the direct dependencies for a package version.
ListPackageVersions: Returns a list of package versions for a specified package in a repository.
ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called this method.
ListRepositoriesInDomain: Returns a list of the repositories in a domain.
PublishPackageVersion: Creates a new package version containing one or more assets.
PutDomainPermissionsPolicy: Attaches a resource policy to a domain.
PutPackageOriginConfiguration: Sets the package origin configuration for a package, which determine how new versions of the package can be added to a specific repository.
PutRepositoryPermissionsPolicy: Sets the resource policy on a repository that specifies permissions to access it.
UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.
UpdateRepository: Updates the properties of a repository.
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.
Copies package versions from one repository to another repository in the same domain.
You must specify versions or versionRevisions. You cannot specify both.
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.
', 'CreateRepository' => 'Creates a repository.
', 'DeleteDomain' => 'Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.
', 'DeleteDomainPermissionsPolicy' => 'Deletes the resource policy set on a domain.
', 'DeletePackage' => '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.
', 'DeletePackageVersions' => ' 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.
Deletes a repository.
', 'DeleteRepositoryPermissionsPolicy' => '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.
Returns a DomainDescription object that contains information about the requested domain.
', 'DescribePackage' => 'Returns a PackageDescription object that contains information about the requested package.
', 'DescribePackageVersion' => 'Returns a PackageVersionDescription object that contains information about the requested package version.
', 'DescribeRepository' => ' Returns a RepositoryDescription object that contains detailed information about the requested repository.
Removes an existing external connection from a repository.
', 'DisposePackageVersions' => ' 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.
', 'GetAuthorizationToken' => ' 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.
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.
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.
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.
', 'GetRepositoryEndpoint' => 'Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
maven
npm
nuget
pypi
Returns the resource policy that is set on a repository.
', 'ListDomains' => ' 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.
Returns a list of AssetSummary objects for assets in a package version.
', 'ListPackageVersionDependencies' => ' 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.
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.
Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
', 'ListRepositories' => ' 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.
Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters.
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
', 'PublishPackageVersion' => '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.
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.
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.
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.
Adds or updates tags for a resource in CodeArtifact.
', 'UntagResource' => 'Removes tags from a resource in CodeArtifact.
', 'UpdatePackageVersionsStatus' => ' 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.
Update the properties of a repository.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'The operation did not succeed because of an unauthorized access attempt.
', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'AssociateExternalConnectionRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'CopyPackageVersionsRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'CreateRepositoryRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'DeleteDomainPermissionsPolicyRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'DeleteDomainRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'DeletePackageRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'DeletePackageVersionsRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'DeleteRepositoryPermissionsPolicyRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'DeleteRepositoryRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'DescribeDomainRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'DescribePackageRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'DescribePackageVersionRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'DescribeRepositoryRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'DisassociateExternalConnectionRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'DisposePackageVersionsRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'DomainDescription$owner' => 'The Amazon Web Services account ID that owns the domain.
', 'DomainSummary$owner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'GetAuthorizationTokenRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'GetDomainPermissionsPolicyRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'GetPackageVersionAssetRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'GetPackageVersionReadmeRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'GetRepositoryEndpointRequest$domainOwner' => '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.
', 'GetRepositoryPermissionsPolicyRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'ListPackageVersionAssetsRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'ListPackageVersionDependenciesRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'ListPackageVersionsRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'ListPackagesRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'ListRepositoriesInDomainRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'ListRepositoriesInDomainRequest$administratorAccount' => 'Filter the list of repositories to only include those that are managed by the Amazon Web Services account ID.
', 'PublishPackageVersionRequest$domainOwner' => 'The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
', 'PutDomainPermissionsPolicyRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'PutPackageOriginConfigurationRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'PutRepositoryPermissionsPolicyRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'RepositoryDescription$administratorAccount' => 'The 12-digit account number of the Amazon Web Services account that manages the repository.
', 'RepositoryDescription$domainOwner' => '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.
', 'RepositorySummary$administratorAccount' => 'The Amazon Web Services account ID that manages the repository.
', 'RepositorySummary$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'UpdatePackageVersionsStatusRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', 'UpdateRepositoryRequest$domainOwner' => 'The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
', ], ], 'AllowPublish' => [ 'base' => NULL, 'refs' => [ 'ListPackagesRequest$publish' => 'The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
The package origin configuration that determines if new versions of the package can be published directly to the repository.
', ], ], 'AllowUpstream' => [ 'base' => NULL, 'refs' => [ 'ListPackagesRequest$upstream' => 'The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
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.
', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$encryptionKey' => ' 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 have kms:DescribeKey and kms:CreateGrant permissions 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.
The Amazon Resource Name (ARN) of the domain.
', 'DomainDescription$encryptionKey' => 'The ARN of an Key Management Service (KMS) key associated with a domain.
', 'DomainDescription$s3BucketArn' => 'The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.
', 'DomainSummary$arn' => 'The ARN of the domain.
', 'DomainSummary$encryptionKey' => 'The key used to encrypt the domain.
', 'ListTagsForResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource to get tags for.
', 'RepositoryDescription$arn' => 'The Amazon Resource Name (ARN) of the repository.
', 'RepositorySummary$arn' => 'The ARN of the repository.
', 'ResourcePolicy$resourceArn' => 'The ARN of the resource associated with the resource policy
', 'TagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.
', 'UntagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
', ], ], 'Asset' => [ 'base' => NULL, 'refs' => [ 'GetPackageVersionAssetResult$asset' => 'The binary file, or asset, that is downloaded.
', 'PublishPackageVersionRequest$assetContent' => 'The content of the asset to publish.
', ], ], 'AssetHashes' => [ 'base' => NULL, 'refs' => [ 'AssetSummary$hashes' => 'The hashes of the asset.
', ], ], 'AssetName' => [ 'base' => NULL, 'refs' => [ 'AssetSummary$name' => 'The name of the asset.
', 'GetPackageVersionAssetRequest$asset' => 'The name of the requested asset.
', 'GetPackageVersionAssetResult$assetName' => 'The name of the asset that is downloaded.
', 'PublishPackageVersionRequest$assetName' => 'The name of the asset to publish. Asset names can include Unicode letters and numbers, and the following special characters: ~ ! @ ^ & ( ) - ` _ + [ ] { } ; , . `
Contains details about a package version asset.
', 'refs' => [ 'AssetSummaryList$member' => NULL, 'PublishPackageVersionResult$asset' => 'An AssetSummary for the published asset.
', ], ], 'AssetSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionAssetsResult$assets' => 'The returned list of AssetSummary objects.
', ], ], 'AssociateExternalConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateExternalConnectionResult' => [ 'base' => NULL, 'refs' => [], ], 'AuthorizationTokenDurationSeconds' => [ 'base' => NULL, 'refs' => [ 'GetAuthorizationTokenRequest$durationSeconds' => 'The time, in seconds, that the generated authorization token is valid. Valid values are 0 and any number between 900 (15 minutes) and 43200 (12 hours). A value of 0 will set the expiration of the authorization token to the same expiration of the user\'s role\'s temporary credentials.
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 failedVersions field of the response with an ALREADY_EXISTS error code.
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.
', 'PublishPackageVersionRequest$unfinished' => 'Specifies whether the package version should remain in the unfinished state. If omitted, the package version status will be set to Published (see Package version status in the CodeArtifact User Guide).
Valid values: unfinished
The operation did not succeed because prerequisites are not met.
', 'refs' => [], ], 'CopyPackageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'CopyPackageVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRepositoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRepositoryResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageResult' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePackageVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRepositoryPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRepositoryPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRepositoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRepositoryResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePackageVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRepositoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRepositoryResult' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateRepositoryRequest$description' => 'A description of the created repository.
', 'RepositoryDescription$description' => 'A text description of the repository.
', 'RepositorySummary$description' => 'The description of the repository.
', 'UpdateRepositoryRequest$description' => 'An updated repository description.
', ], ], 'DisassociateExternalConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateExternalConnectionResult' => [ 'base' => NULL, 'refs' => [], ], 'DisposePackageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisposePackageVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DomainDescription' => [ 'base' => '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.
', 'refs' => [ 'CreateDomainResult$domain' => 'Contains information about the created domain after processing the request.
', 'DeleteDomainResult$domain' => 'Contains information about the deleted domain after processing the request.
', 'DescribeDomainResult$domain' => NULL, ], ], 'DomainEntryPoint' => [ 'base' => '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.
', 'refs' => [ 'PackageVersionOrigin$domainEntryPoint' => 'A DomainEntryPoint object that contains information about from which repository or external connection the package version was added to the domain.
', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'AssociateExternalConnectionRequest$domain' => 'The name of the domain that contains the repository.
', 'CopyPackageVersionsRequest$domain' => 'The name of the domain that contains the source and destination repositories.
', 'CreateDomainRequest$domain' => '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.
', 'CreateRepositoryRequest$domain' => 'The name of the domain that contains the created repository.
', 'DeleteDomainPermissionsPolicyRequest$domain' => 'The name of the domain associated with the resource policy to be deleted.
', 'DeleteDomainRequest$domain' => 'The name of the domain to delete.
', 'DeletePackageRequest$domain' => 'The name of the domain that contains the package to delete.
', 'DeletePackageVersionsRequest$domain' => 'The name of the domain that contains the package to delete.
', 'DeleteRepositoryPermissionsPolicyRequest$domain' => 'The name of the domain that contains the repository associated with the resource policy to be deleted.
', 'DeleteRepositoryRequest$domain' => 'The name of the domain that contains the repository to delete.
', 'DescribeDomainRequest$domain' => 'A string that specifies the name of the requested domain.
', 'DescribePackageRequest$domain' => 'The name of the domain that contains the repository that contains the package.
', 'DescribePackageVersionRequest$domain' => 'The name of the domain that contains the repository that contains the package version.
', 'DescribeRepositoryRequest$domain' => 'The name of the domain that contains the repository to describe.
', 'DisassociateExternalConnectionRequest$domain' => 'The name of the domain that contains the repository from which to remove the external repository.
', 'DisposePackageVersionsRequest$domain' => 'The name of the domain that contains the repository you want to dispose.
', 'DomainDescription$name' => 'The name of the domain.
', 'DomainSummary$name' => 'The name of the domain.
', 'GetAuthorizationTokenRequest$domain' => 'The name of the domain that is in scope for the generated authorization token.
', 'GetDomainPermissionsPolicyRequest$domain' => 'The name of the domain to which the resource policy is attached.
', 'GetPackageVersionAssetRequest$domain' => 'The name of the domain that contains the repository that contains the package version with the requested asset.
', 'GetPackageVersionReadmeRequest$domain' => 'The name of the domain that contains the repository that contains the package version with the requested readme file.
', 'GetRepositoryEndpointRequest$domain' => 'The name of the domain that contains the repository.
', 'GetRepositoryPermissionsPolicyRequest$domain' => 'The name of the domain containing the repository whose associated resource policy is to be retrieved.
', 'ListPackageVersionAssetsRequest$domain' => 'The name of the domain that contains the repository associated with the package version assets.
', 'ListPackageVersionDependenciesRequest$domain' => 'The name of the domain that contains the repository that contains the requested package version dependencies.
', 'ListPackageVersionsRequest$domain' => 'The name of the domain that contains the repository that contains the requested package versions.
', 'ListPackagesRequest$domain' => 'The name of the domain that contains the repository that contains the requested packages.
', 'ListRepositoriesInDomainRequest$domain' => 'The name of the domain that contains the returned list of repositories.
', 'PublishPackageVersionRequest$domain' => 'The name of the domain that contains the repository that contains the package version to publish.
', 'PutDomainPermissionsPolicyRequest$domain' => 'The name of the domain on which to set the resource policy.
', 'PutPackageOriginConfigurationRequest$domain' => 'The name of the domain that contains the repository that contains the package.
', 'PutRepositoryPermissionsPolicyRequest$domain' => 'The name of the domain containing the repository to set the resource policy on.
', 'RepositoryDescription$domainName' => 'The name of the domain that contains the repository.
', 'RepositorySummary$domainName' => 'The name of the domain that contains the repository.
', 'UpdatePackageVersionsStatusRequest$domain' => 'The name of the domain that contains the repository that contains the package versions with a status to be updated.
', 'UpdateRepositoryRequest$domain' => 'The name of the domain associated with the repository to update.
', ], ], 'DomainStatus' => [ 'base' => NULL, 'refs' => [ 'DomainDescription$status' => 'The current status of a domain.
', 'DomainSummary$status' => 'A string that contains the status of the domain.
', ], ], 'DomainSummary' => [ 'base' => ' Information about a domain, including its name, Amazon Resource Name (ARN), and status. The ListDomains operation returns a list of DomainSummary objects.
The returned list of DomainSummary objects.
', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'PackageVersionError$errorMessage' => 'The error message associated with the error.
', ], ], 'ExternalConnectionName' => [ 'base' => NULL, 'refs' => [ 'AssociateExternalConnectionRequest$externalConnection' => '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.
The name of the external connection to be removed from the repository.
', 'DomainEntryPoint$externalConnectionName' => 'The name of the external connection that a package was ingested from.
', 'RepositoryExternalConnectionInfo$externalConnectionName' => 'The name of the external connection associated with a repository.
', ], ], 'ExternalConnectionStatus' => [ 'base' => NULL, 'refs' => [ 'RepositoryExternalConnectionInfo$status' => ' The status of the external connection of a repository. There is one valid value, Available.
The number of repositories in the domain.
', ], ], 'InternalServerException' => [ 'base' => 'The operation did not succeed because of an error that occurred inside CodeArtifact.
', 'refs' => [], ], 'LicenseInfo' => [ 'base' => 'Details of the license data.
', 'refs' => [ 'LicenseInfoList$member' => NULL, ], ], 'LicenseInfoList' => [ 'base' => NULL, 'refs' => [ 'PackageVersionDescription$licenses' => 'Information about licenses associated with the package version.
', ], ], 'ListDomainsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListDomainsRequest$maxResults' => 'The maximum number of results to return per page.
', ], ], 'ListDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionAssetsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionAssetsRequest$maxResults' => 'The maximum number of results to return per page.
', ], ], 'ListPackageVersionAssetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionAssetsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionDependenciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionDependenciesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionsRequest$maxResults' => 'The maximum number of results to return per page.
', ], ], 'ListPackageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackageVersionsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPackagesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPackagesRequest$maxResults' => 'The maximum number of results to return per page.
', ], ], 'ListPackagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPackagesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListRepositoriesInDomainMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListRepositoriesInDomainRequest$maxResults' => 'The maximum number of results to return per page.
', ], ], 'ListRepositoriesInDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRepositoriesInDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'ListRepositoriesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListRepositoriesRequest$maxResults' => 'The maximum number of results to return per page.
', ], ], 'ListRepositoriesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRepositoriesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'DomainDescription$assetSizeBytes' => 'The total size of all assets in the domain.
', ], ], 'LongOptional' => [ 'base' => NULL, 'refs' => [ 'AssetSummary$size' => 'The size of the asset.
', ], ], 'PackageDependency' => [ 'base' => 'Details about a package dependency.
', 'refs' => [ 'PackageDependencyList$member' => NULL, ], ], 'PackageDependencyList' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionDependenciesResult$dependencies' => 'The returned list of PackageDependency objects.
', ], ], 'PackageDescription' => [ 'base' => 'Details about a package.
', 'refs' => [ 'DescribePackageResult$package' => 'A PackageDescription object that contains information about the requested package.
', ], ], 'PackageFormat' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsRequest$format' => 'The format of the package versions to be copied.
', 'DeletePackageRequest$format' => 'The format of the requested package to delete.
', 'DeletePackageVersionsRequest$format' => 'The format of the package versions to delete.
', 'DescribePackageRequest$format' => 'A format that specifies the type of the requested package.
', 'DescribePackageVersionRequest$format' => 'A format that specifies the type of the requested package version.
', 'DisposePackageVersionsRequest$format' => 'A format that specifies the type of package versions you want to dispose.
', 'GetPackageVersionAssetRequest$format' => 'A format that specifies the type of the package version with the requested asset file.
', 'GetPackageVersionReadmeRequest$format' => 'A format that specifies the type of the package version with the requested readme file.
', 'GetPackageVersionReadmeResult$format' => 'The format of the package with the requested readme file.
', 'GetRepositoryEndpointRequest$format' => 'Returns which endpoint of a repository to return. A repository has one endpoint for each package format.
', 'ListPackageVersionAssetsRequest$format' => 'The format of the package that contains the requested package version assets.
', 'ListPackageVersionAssetsResult$format' => 'The format of the package that contains the requested package version assets.
', 'ListPackageVersionDependenciesRequest$format' => 'The format of the package with the requested dependencies.
', 'ListPackageVersionDependenciesResult$format' => 'A format that specifies the type of the package that contains the returned dependencies.
', 'ListPackageVersionsRequest$format' => 'The format of the package versions you want to list.
', 'ListPackageVersionsResult$format' => 'A format of the package.
', 'ListPackagesRequest$format' => 'The format used to filter requested packages. Only packages from the provided format will be returned.
', 'PackageDescription$format' => 'A format that specifies the type of the package.
', 'PackageSummary$format' => 'The format of the package.
', 'PackageVersionDescription$format' => 'The format of the package version.
', 'PublishPackageVersionRequest$format' => 'A format that specifies the type of the package version with the requested asset file.
The only supported value is generic.
The format of the package version.
', 'PutPackageOriginConfigurationRequest$format' => 'A format that specifies the type of the package to be updated.
', 'RepositoryExternalConnectionInfo$packageFormat' => '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.
A format that specifies the type of the package with the statuses to update.
', ], ], 'PackageName' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsRequest$package' => 'The name of the package that contains the versions to be copied.
', 'DeletePackageRequest$package' => 'The name of the package to delete.
', 'DeletePackageVersionsRequest$package' => 'The name of the package with the versions to delete.
', 'DescribePackageRequest$package' => 'The name of the requested package.
', 'DescribePackageVersionRequest$package' => 'The name of the requested package version.
', 'DisposePackageVersionsRequest$package' => 'The name of the package with the versions you want to dispose.
', 'GetPackageVersionAssetRequest$package' => 'The name of the package that contains the requested asset.
', 'GetPackageVersionReadmeRequest$package' => 'The name of the package version that contains the requested readme file.
', 'GetPackageVersionReadmeResult$package' => 'The name of the package that contains the returned readme file.
', 'ListPackageVersionAssetsRequest$package' => 'The name of the package that contains the requested package version assets.
', 'ListPackageVersionAssetsResult$package' => 'The name of the package that contains the requested package version assets.
', 'ListPackageVersionDependenciesRequest$package' => 'The name of the package versions\' package.
', 'ListPackageVersionDependenciesResult$package' => 'The name of the package that contains the returned package versions dependencies.
', 'ListPackageVersionsRequest$package' => 'The name of the package for which you want to request package versions.
', 'ListPackageVersionsResult$package' => 'The name of the package.
', 'ListPackagesRequest$packagePrefix' => ' A prefix used to filter requested packages. Only packages with names that start with packagePrefix are returned.
The name of the package that this package depends on.
', 'PackageDescription$name' => 'The name of the package.
', 'PackageSummary$package' => 'The name of the package.
', 'PackageVersionDescription$packageName' => 'The name of the requested package.
', 'PublishPackageVersionRequest$package' => 'The name of the package version to publish.
', 'PublishPackageVersionResult$package' => 'The name of the package.
', 'PutPackageOriginConfigurationRequest$package' => 'The name of the package to be updated.
', 'UpdatePackageVersionsStatusRequest$package' => 'The name of the package with the version statuses to update.
', ], ], 'PackageNamespace' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsRequest$namespace' => '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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 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.
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.
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.
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 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 --namespace and 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.
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.
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.
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.
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.
The namespace of the package version to publish.
', 'PublishPackageVersionResult$namespace' => 'The namespace of the package version.
', 'PutPackageOriginConfigurationRequest$namespace' => '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.
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.
Details about the package origin configuration of a package.
', 'refs' => [ 'PackageDescription$originConfiguration' => 'The package origin configuration for the package.
', 'PackageSummary$originConfiguration' => 'A PackageOriginConfiguration object that contains a PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions.
', 'PutPackageOriginConfigurationResult$originConfiguration' => '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.
', ], ], 'PackageOriginRestrictions' => [ 'base' => '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.
', 'refs' => [ 'PackageOriginConfiguration$restrictions' => 'A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.
A PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions. The upstream restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. The publish restriction determines if new package versions can be published directly to the repository.
You must include both the desired upstream and publish restrictions.
Details about a package, including its format, namespace, and name.
', 'refs' => [ 'DeletePackageResult$deletedPackage' => NULL, 'PackageSummaryList$member' => NULL, ], ], 'PackageSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPackagesResult$packages' => 'The list of returned PackageSummary objects.
', ], ], 'PackageVersion' => [ 'base' => NULL, 'refs' => [ 'DescribePackageVersionRequest$packageVersion' => ' A string that contains the package version (for example, 3.5.2).
A string that contains the package version (for example, 3.5.2).
A string that contains the package version (for example, 3.5.2).
A string that contains the package version (for example, 3.5.2).
The version of the package with the requested readme file.
', 'ListPackageVersionAssetsRequest$packageVersion' => ' A string that contains the package version (for example, 3.5.2).
The version of the package associated with the requested assets.
', 'ListPackageVersionDependenciesRequest$packageVersion' => ' A string that contains the package version (for example, 3.5.2).
The version of the package that is specified in the request.
', 'ListPackageVersionsResult$defaultDisplayVersion' => '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 latest tag. If the latest tag is not set, it\'s the most recently published package version.
The version of the package.
', 'PackageVersionErrorMap$key' => NULL, 'PackageVersionList$member' => NULL, 'PackageVersionRevisionMap$key' => NULL, 'PackageVersionSummary$version' => 'Information about a package version.
', 'PublishPackageVersionRequest$packageVersion' => 'The package version to publish (for example, 3.5.2).
The version of the package.
', 'SuccessfulPackageVersionInfoMap$key' => NULL, ], ], 'PackageVersionDescription' => [ 'base' => 'Details about a package version.
', 'refs' => [ 'DescribePackageVersionResult$packageVersion' => 'A PackageVersionDescription object that contains information about the requested package version.
', ], ], 'PackageVersionError' => [ 'base' => 'l An error associated with package.
', 'refs' => [ 'PackageVersionErrorMap$value' => NULL, ], ], 'PackageVersionErrorCode' => [ 'base' => NULL, 'refs' => [ 'PackageVersionError$errorCode' => 'The error code associated with the error. Valid error codes are:
ALREADY_EXISTS
MISMATCHED_REVISION
MISMATCHED_STATUS
NOT_ALLOWED
NOT_FOUND
SKIPPED
A map of package versions that failed to copy and their error codes. The possible error codes are in the PackageVersionError data type. They are:
ALREADY_EXISTS
MISMATCHED_REVISION
MISMATCHED_STATUS
NOT_ALLOWED
NOT_FOUND
SKIPPED
A PackageVersionError object 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
A PackageVersionError object 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
A list of SuccessfulPackageVersionInfo objects, one for each package version with a status that successfully updated.
The versions of the package to be copied.
You must specify versions or versionRevisions. You cannot specify both.
An array of strings that specify the versions of the package to delete.
', 'DisposePackageVersionsRequest$versions' => 'The versions of the package you want to dispose.
', 'UpdatePackageVersionsStatusRequest$versions' => 'An array of strings that specify the versions of the package with the statuses to update.
', ], ], 'PackageVersionOrigin' => [ 'base' => 'Information about how a package version was added to a repository.
', 'refs' => [ 'PackageVersionDescription$origin' => 'A PackageVersionOrigin object that contains information about how the package version was added to the repository.
', 'PackageVersionSummary$origin' => 'A PackageVersionOrigin object that contains information about how the package version was added to the repository.
', ], ], 'PackageVersionOriginType' => [ 'base' => NULL, 'refs' => [ 'ListPackageVersionsRequest$originType' => 'The originType used to filter package versions. Only package versions with the provided originType will be returned.
Describes how the package version was originally added to the domain. An INTERNAL origin type means the package version was published directly to a repository in the domain. An EXTERNAL origin type means the package version was ingested from an external connection.
The name of the package version revision that contains the requested asset.
', 'GetPackageVersionAssetResult$packageVersionRevision' => 'The name of the package version revision that contains the downloaded asset.
', 'GetPackageVersionReadmeResult$versionRevision' => 'The current revision associated with the package version.
', 'ListPackageVersionAssetsResult$versionRevision' => 'The current revision associated with the package version.
', 'ListPackageVersionDependenciesResult$versionRevision' => 'The current revision associated with the package version.
', 'PackageVersionDescription$revision' => 'The revision of the package version.
', 'PackageVersionRevisionMap$value' => NULL, 'PackageVersionSummary$revision' => 'The revision associated with a package version.
', 'PublishPackageVersionResult$versionRevision' => 'The revision of the package version.
', ], ], 'PackageVersionRevisionMap' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsRequest$versionRevisions' => ' A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation succeeds if the specified versions in the source repository match the specified package version revision.
You must specify versions or versionRevisions. You cannot specify both.
The revisions of the package versions you want to dispose.
', 'UpdatePackageVersionsStatusRequest$versionRevisions' => ' A map of package versions and package version revisions. The map key is the package version (for example, 3.5.2), and the map value is the package version revision.
How to sort the requested list of package versions.
', ], ], 'PackageVersionStatus' => [ 'base' => NULL, 'refs' => [ 'DeletePackageVersionsRequest$expectedStatus' => 'The expected status of the package version to delete.
', 'DisposePackageVersionsRequest$expectedStatus' => 'The expected status of the package version to dispose.
', 'ListPackageVersionsRequest$status' => 'A string that filters the requested package versions by status.
', 'PackageVersionDescription$status' => 'A string that contains the status of the package version.
', 'PackageVersionSummary$status' => 'A string that contains the status of the package version. It can be one of the following:
', 'PublishPackageVersionResult$status' => 'A string that contains the status of the package version. For more information, see Package version status in the CodeArtifact User Guide.
', 'SuccessfulPackageVersionInfo$status' => 'The status of a package version.
', 'UpdatePackageVersionsStatusRequest$expectedStatus' => ' The package version’s expected status before it is updated. If expectedStatus is provided, the package version\'s status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus.
The status you want to change the package version status to.
', ], ], 'PackageVersionSummary' => [ 'base' => ' Details about a package version, including its status, version, and revision. The ListPackageVersions operation returns a list of PackageVersionSummary objects.
The returned list of PackageVersionSummary objects.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListDomainsRequest$nextToken' => '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.
', 'ListDomainsResult$nextToken' => '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.
', 'ListPackageVersionAssetsRequest$nextToken' => '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.
', 'ListPackageVersionAssetsResult$nextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListPackageVersionDependenciesRequest$nextToken' => '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.
', 'ListPackageVersionDependenciesResult$nextToken' => '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.
', 'ListPackageVersionsRequest$nextToken' => '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.
', 'ListPackageVersionsResult$nextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListPackagesRequest$nextToken' => '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.
', 'ListPackagesResult$nextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListRepositoriesInDomainRequest$nextToken' => '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.
', 'ListRepositoriesInDomainResult$nextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListRepositoriesRequest$nextToken' => '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.
', 'ListRepositoriesResult$nextToken' => 'If there are additional results, this is the token for the next set of results.
', ], ], 'PolicyDocument' => [ 'base' => NULL, 'refs' => [ 'PutDomainPermissionsPolicyRequest$policyDocument' => 'A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.
', 'PutRepositoryPermissionsPolicyRequest$policyDocument' => 'A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository.
', 'ResourcePolicy$document' => 'The resource policy formatted in JSON.
', ], ], 'PolicyRevision' => [ 'base' => NULL, 'refs' => [ 'DeleteDomainPermissionsPolicyRequest$policyRevision' => '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.
', 'DeleteRepositoryPermissionsPolicyRequest$policyRevision' => '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.
', 'PutDomainPermissionsPolicyRequest$policyRevision' => '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.
', 'PutRepositoryPermissionsPolicyRequest$policyRevision' => '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.
', 'ResourcePolicy$revision' => 'The current revision of the resource policy.
', ], ], 'PublishPackageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'PublishPackageVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'PutDomainPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutDomainPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'PutPackageOriginConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutPackageOriginConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'PutRepositoryPermissionsPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRepositoryPermissionsPolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'RepositoryDescription' => [ 'base' => ' 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.
Information about the connected repository after processing the request.
', 'CreateRepositoryResult$repository' => 'Information about the created repository after processing the request.
', 'DeleteRepositoryResult$repository' => 'Information about the deleted repository after processing the request.
', 'DescribeRepositoryResult$repository' => ' A RepositoryDescription object that contains the requested repository information.
The repository associated with the removed external connection.
', 'UpdateRepositoryResult$repository' => 'The updated repository.
', ], ], 'RepositoryExternalConnectionInfo' => [ 'base' => 'Contains information about the external connection of a repository.
', 'refs' => [ 'RepositoryExternalConnectionInfoList$member' => NULL, ], ], 'RepositoryExternalConnectionInfoList' => [ 'base' => NULL, 'refs' => [ 'RepositoryDescription$externalConnections' => 'An array of external connections associated with the repository.
', ], ], 'RepositoryName' => [ 'base' => NULL, 'refs' => [ 'AssociateExternalConnectionRequest$repository' => 'The name of the repository to which the external connection is added.
', 'CopyPackageVersionsRequest$sourceRepository' => 'The name of the repository that contains the package versions to be copied.
', 'CopyPackageVersionsRequest$destinationRepository' => 'The name of the repository into which package versions are copied.
', 'CreateRepositoryRequest$repository' => 'The name of the repository to create.
', 'DeletePackageRequest$repository' => 'The name of the repository that contains the package to delete.
', 'DeletePackageVersionsRequest$repository' => 'The name of the repository that contains the package versions to delete.
', 'DeleteRepositoryPermissionsPolicyRequest$repository' => 'The name of the repository that is associated with the resource policy to be deleted
', 'DeleteRepositoryRequest$repository' => 'The name of the repository to delete.
', 'DescribePackageRequest$repository' => 'The name of the repository that contains the requested package.
', 'DescribePackageVersionRequest$repository' => 'The name of the repository that contains the package version.
', 'DescribeRepositoryRequest$repository' => 'A string that specifies the name of the requested repository.
', 'DisassociateExternalConnectionRequest$repository' => 'The name of the repository from which the external connection will be removed.
', 'DisposePackageVersionsRequest$repository' => 'The name of the repository that contains the package versions you want to dispose.
', 'DomainEntryPoint$repositoryName' => 'The name of the repository that a package was originally published to.
', 'GetPackageVersionAssetRequest$repository' => 'The repository that contains the package version with the requested asset.
', 'GetPackageVersionReadmeRequest$repository' => 'The repository that contains the package with the requested readme file.
', 'GetRepositoryEndpointRequest$repository' => 'The name of the repository.
', 'GetRepositoryPermissionsPolicyRequest$repository' => 'The name of the repository whose associated resource policy is to be retrieved.
', 'ListPackageVersionAssetsRequest$repository' => 'The name of the repository that contains the package that contains the requested package version assets.
', 'ListPackageVersionDependenciesRequest$repository' => 'The name of the repository that contains the requested package version.
', 'ListPackageVersionsRequest$repository' => 'The name of the repository that contains the requested package versions.
', 'ListPackagesRequest$repository' => 'The name of the repository that contains the requested packages.
', 'ListRepositoriesInDomainRequest$repositoryPrefix' => ' A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.
A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.
The name of the repository that the package version will be published to.
', 'PutPackageOriginConfigurationRequest$repository' => 'The name of the repository that contains the package.
', 'PutRepositoryPermissionsPolicyRequest$repository' => 'The name of the repository to set the resource policy on.
', 'RepositoryDescription$name' => 'The name of the repository.
', 'RepositorySummary$name' => 'The name of the repository.
', 'UpdatePackageVersionsStatusRequest$repository' => 'The repository that contains the package versions with the status you want to update.
', 'UpdateRepositoryRequest$repository' => 'The name of the repository to update.
', 'UpstreamRepository$repositoryName' => 'The name of an upstream repository.
', 'UpstreamRepositoryInfo$repositoryName' => 'The name of an upstream repository.
', ], ], 'RepositorySummary' => [ 'base' => ' Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The ListRepositories operation returns a list of RepositorySummary objects.
The returned list of repositories.
', 'ListRepositoriesResult$repositories' => 'The returned list of RepositorySummary objects.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The operation did not succeed because the resource requested is not found in the service.
', 'refs' => [], ], 'ResourcePolicy' => [ 'base' => 'An CodeArtifact resource policy that contains a resource ARN, document details, and a revision.
', 'refs' => [ 'DeleteDomainPermissionsPolicyResult$policy' => 'Information about the deleted resource policy after processing the request.
', 'DeleteRepositoryPermissionsPolicyResult$policy' => 'Information about the deleted policy after processing the request.
', 'GetDomainPermissionsPolicyResult$policy' => 'The returned resource policy.
', 'GetRepositoryPermissionsPolicyResult$policy' => 'The returned resource policy.
', 'PutDomainPermissionsPolicyResult$policy' => 'The resource policy that was set after processing the request.
', 'PutRepositoryPermissionsPolicyResult$policy' => 'The resource policy that was set after processing the request.
', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ConflictException$resourceType' => 'The type of Amazon Web Services resource.
', 'ResourceNotFoundException$resourceType' => 'The type of Amazon Web Services resource.
', 'ServiceQuotaExceededException$resourceType' => 'The type of Amazon Web Services resource.
', ], ], 'RetryAfterSeconds' => [ 'base' => NULL, 'refs' => [ 'ThrottlingException$retryAfterSeconds' => 'The time period, in seconds, to wait before retrying the request.
', ], ], 'SHA256' => [ 'base' => NULL, 'refs' => [ 'PublishPackageVersionRequest$assetSHA256' => 'The SHA256 hash of the assetContent to 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 assetContent has not changed after it was originally sent.
The operation did not succeed because it would have exceeded a service limit for your account.
', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => NULL, 'ConflictException$resourceId' => 'The ID of the resource.
', 'GetAuthorizationTokenResult$authorizationToken' => 'The returned authentication token.
', 'GetPackageVersionReadmeResult$readme' => 'The text of the returned readme file.
', 'GetRepositoryEndpointResult$repositoryEndpoint' => 'A string that specifies the URL of the returned endpoint.
', 'InternalServerException$message' => NULL, 'LicenseInfo$name' => 'Name of the license.
', 'LicenseInfo$url' => 'The URL for license data.
', 'PackageDependency$dependencyType' => '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 parent is 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 dependencyType field is never set for NuGet packages.
pypi: Requires-Dist
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, or 4.x.
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.
', 'PackageVersionDescription$homePage' => 'The homepage associated with the package.
', 'PackageVersionDescription$sourceCodeRepository' => 'The repository for the source code in the package version, or the source code used to build it.
', 'ResourceNotFoundException$message' => NULL, 'ResourceNotFoundException$resourceId' => 'The ID of the resource.
', 'ServiceQuotaExceededException$message' => NULL, 'ServiceQuotaExceededException$resourceId' => 'The ID of the resource.
', 'SuccessfulPackageVersionInfo$revision' => 'The revision of a package version.
', 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'String255' => [ 'base' => NULL, 'refs' => [ 'PackageVersionDescription$displayName' => ' The name of the package that is displayed. The displayName varies depending on the package version\'s format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.
Contains the revision and status of a package version.
', 'refs' => [ 'SuccessfulPackageVersionInfoMap$value' => NULL, ], ], 'SuccessfulPackageVersionInfoMap' => [ 'base' => NULL, 'refs' => [ 'CopyPackageVersionsResult$successfulVersions' => 'A list of the package versions that were successfully copied to your repository.
', 'DeletePackageVersionsResult$successfulVersions' => ' A list of the package versions that were successfully deleted. The status of every successful version will be Deleted.
A list of the package versions that were successfully disposed.
', 'UpdatePackageVersionsStatusResult$successfulVersions' => ' A list of PackageVersionError objects, one for each package version with a status that failed to update.
A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => 'The tag key.
', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'The tag key for each tag that you want to remove from the resource.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$tags' => 'One or more tag key-value pairs for the domain.
', 'CreateRepositoryRequest$tags' => 'One or more tag key-value pairs for the repository.
', 'ListTagsForResourceResult$tags' => 'A list of tag key and value pairs associated with the specified resource.
', 'TagResourceRequest$tags' => 'The tags you want to modify or add to the resource.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => 'The tag value.
', ], ], 'ThrottlingException' => [ 'base' => 'The operation did not succeed because too many requests are sent to the service.
', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'DomainDescription$createdTime' => 'A timestamp that represents the date and time the domain was created.
', 'DomainSummary$createdTime' => 'A timestamp that contains the date and time the domain was created.
', 'GetAuthorizationTokenResult$expiration' => 'A timestamp that specifies the date and time the authorization token expires.
', 'PackageVersionDescription$publishedTime' => 'A timestamp that contains the date and time the package version was published.
', 'RepositoryDescription$createdTime' => 'A timestamp that represents the date and time the repository was created.
', 'RepositorySummary$createdTime' => 'A timestamp that represents the date and time the repository was created.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageVersionsStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePackageVersionsStatusResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRepositoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRepositoryResult' => [ 'base' => NULL, 'refs' => [], ], 'UpstreamRepository' => [ 'base' => ' Information about an upstream repository. A list of UpstreamRepository objects is an input parameter to CreateRepository and UpdateRepository.
Information about an upstream repository.
', 'refs' => [ 'UpstreamRepositoryInfoList$member' => NULL, ], ], 'UpstreamRepositoryInfoList' => [ 'base' => NULL, 'refs' => [ 'RepositoryDescription$upstreams' => '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.
', ], ], 'UpstreamRepositoryList' => [ 'base' => NULL, 'refs' => [ 'CreateRepositoryRequest$upstreams' => '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.
', 'UpdateRepositoryRequest$upstreams' => '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.
', ], ], 'ValidationException' => [ 'base' => 'The operation did not succeed because a parameter in the request was sent with an invalid value.
', 'refs' => [], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$reason' => '', ], ], ],];