Class: AWS.CodeArtifact

var params = {
  destinationRepository: 'STRING_VALUE', /* required */
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo, /* required */
  package: 'STRING_VALUE', /* required */
  sourceRepository: 'STRING_VALUE', /* required */
  allowOverwrite: true || false,
  domainOwner: 'STRING_VALUE',
  includeFromUpstream: true || false,
  namespace: 'STRING_VALUE',
  versionRevisions: {
    '<PackageVersion>': 'STRING_VALUE',
    /* '<PackageVersion>': ... */
  },
  versions: [
    'STRING_VALUE',
    /* more items */
  ]
};
codeartifact.copyPackageVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the source and destination repositories.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • sourceRepository — (String)

    The name of the repository that contains the package versions to be copied.

  • destinationRepository — (String)

    The name of the repository into which package versions are copied.

  • format — (String)

    The format of the package versions to be copied.

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"
  • namespace — (String)

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

    Note: The namespace is required when copying package versions of the following formats:

    • Maven
    • Swift
    • generic

    • The namespace of a Maven package version is its groupId.

    • The namespace of an npm or Swift package version is its scope.

    • The namespace of a generic package is its namespace.

    • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • package — (String)

    The name of the package that contains the versions to be copied.

  • versions — (Array<String>)

    The versions of the package to be copied.

    Note: You must specify versions or versionRevisions. You cannot specify both.
  • versionRevisions — (map<String>)

    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.

    Note: You must specify versions or versionRevisions. You cannot specify both.
  • allowOverwrite — (Boolean)

    Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the failedVersions field of the response with an ALREADY_EXISTS error code.

  • includeFromUpstream — (Boolean)

    Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see Working with upstream repositories.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • successfulVersions — (map<map>)

      A list of the package versions that were successfully copied to your repository.

      • revision — (String)

        The revision of a package version.

      • status — (String)

        The status of a package version.

        Possible values include:
        • "Published"
        • "Unfinished"
        • "Unlisted"
        • "Archived"
        • "Disposed"
        • "Deleted"
    • failedVersions — (map<map>)

      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

      • errorCode — (String)

        The error code associated with the error. Valid error codes are:

        • ALREADY_EXISTS

        • MISMATCHED_REVISION

        • MISMATCHED_STATUS

        • NOT_ALLOWED

        • NOT_FOUND

        • SKIPPED

        Possible values include:
        • "ALREADY_EXISTS"
        • "MISMATCHED_REVISION"
        • "MISMATCHED_STATUS"
        • "NOT_ALLOWED"
        • "NOT_FOUND"
        • "SKIPPED"
      • errorMessage — (String)

        The error message associated with the error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  encryptionKey: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
codeartifact.createDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.

  • encryptionKey — (String)

    The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must 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.

  • tags — (Array<map>)

    One or more tag key-value pairs for the domain.

    • key — required — (String)

      The tag key.

    • value — required — (String)

      The tag value.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • domain — (map)

      Contains information about the created domain after processing the request.

      • name — (String)

        The name of the domain.

      • owner — (String)

        The Amazon Web Services account ID that owns the domain.

      • arn — (String)

        The Amazon Resource Name (ARN) of the domain.

      • status — (String)

        The current status of a domain.

        Possible values include:
        • "Active"
        • "Deleted"
      • createdTime — (Date)

        A timestamp that represents the date and time the domain was created.

      • encryptionKey — (String)

        The ARN of an Key Management Service (KMS) key associated with a domain.

      • repositoryCount — (Integer)

        The number of repositories in the domain.

      • assetSizeBytes — (Integer)

        The total size of all assets in the domain.

      • s3BucketArn — (String)

        The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  packageGroup: 'STRING_VALUE', /* required */
  contactInfo: 'STRING_VALUE',
  description: 'STRING_VALUE',
  domainOwner: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
codeartifact.createPackageGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain in which you want to create a package group.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • packageGroup — (String)

    The pattern of the package group to create. The pattern is also the identifier of the package group.

  • contactInfo — (String)

    The contact information for the created package group.

  • description — (String)

    A description of the package group.

  • tags — (Array<map>)

    One or more tag key-value pairs for the package group.

    • key — required — (String)

      The tag key.

    • value — required — (String)

      The tag value.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • packageGroup — (map)

      Information about the created package group after processing the request.

      • arn — (String)

        The ARN of the package group.

      • pattern — (String)

        The pattern of the package group. The pattern determines which packages are associated with the package group.

      • domainName — (String)

        The name of the domain that contains the package group.

      • domainOwner — (String)

        The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

      • createdTime — (Date)

        A timestamp that represents the date and time the package group was created.

      • contactInfo — (String)

        The contact information of the package group.

      • description — (String)

        The description of the package group.

      • originConfiguration — (map)

        The package group origin configuration that determines how package versions can enter repositories.

        • restrictions — (map<map>)

          The origin configuration settings that determine how package versions can enter repositories.

          • mode — (String)

            The package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

            Possible values include:
            • "ALLOW"
            • "ALLOW_SPECIFIC_REPOSITORIES"
            • "BLOCK"
            • "INHERIT"
          • effectiveMode — (String)

            The effective package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value of mode is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

            Possible values include:
            • "ALLOW"
            • "ALLOW_SPECIFIC_REPOSITORIES"
            • "BLOCK"
            • "INHERIT"
          • inheritedFrom — (map)

            The parent package group that the package group origin restrictions are inherited from.

            • arn — (String)

              The ARN of the package group.

            • pattern — (String)

              The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

          • repositoriesCount — (Integer)

            The number of repositories in the allowed repository list.

      • parent — (map)

        The direct parent package group of the package group.

        • arn — (String)

          The ARN of the package group.

        • pattern — (String)

          The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  domainOwner: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  upstreams: [
    {
      repositoryName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
codeartifact.createRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the created repository.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository to create.

  • description — (String)

    A description of the created repository.

  • upstreams — (Array<map>)

    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.

    • repositoryName — required — (String)

      The name of an upstream repository.

  • tags — (Array<map>)

    One or more tag key-value pairs for the repository.

    • key — required — (String)

      The tag key.

    • value — required — (String)

      The tag value.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • repository — (map)

      Information about the created repository after processing the request.

      • name — (String)

        The name of the repository.

      • administratorAccount — (String)

        The 12-digit account number of the Amazon Web Services account that manages the repository.

      • domainName — (String)

        The name of the domain that contains the repository.

      • domainOwner — (String)

        The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

      • arn — (String)

        The Amazon Resource Name (ARN) of the repository.

      • description — (String)

        A text description of the repository.

      • upstreams — (Array<map>)

        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.

        • repositoryName — (String)

          The name of an upstream repository.

      • externalConnections — (Array<map>)

        An array of external connections associated with the repository.

        • externalConnectionName — (String)

          The name of the external connection associated with a repository.

        • packageFormat — (String)

          The package format associated with a repository's external connection. The valid package formats are:

          • npm: A Node Package Manager (npm) package.

          • pypi: A Python Package Index (PyPI) package.

          • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

          • nuget: A NuGet package.

          Possible values include:
          • "npm"
          • "pypi"
          • "maven"
          • "nuget"
          • "generic"
          • "ruby"
          • "swift"
          • "cargo"
        • status — (String)

          The status of the external connection of a repository. There is one valid value, Available.

          Possible values include:
          • "Available"
      • createdTime — (Date)

        A timestamp that represents the date and time the repository was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.deleteDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain to delete.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • domain — (map)

      Contains information about the deleted domain after processing the request.

      • name — (String)

        The name of the domain.

      • owner — (String)

        The Amazon Web Services account ID that owns the domain.

      • arn — (String)

        The Amazon Resource Name (ARN) of the domain.

      • status — (String)

        The current status of a domain.

        Possible values include:
        • "Active"
        • "Deleted"
      • createdTime — (Date)

        A timestamp that represents the date and time the domain was created.

      • encryptionKey — (String)

        The ARN of an Key Management Service (KMS) key associated with a domain.

      • repositoryCount — (Integer)

        The number of repositories in the domain.

      • assetSizeBytes — (Integer)

        The total size of all assets in the domain.

      • s3BucketArn — (String)

        The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  policyRevision: 'STRING_VALUE'
};
codeartifact.deleteDomainPermissionsPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain associated with the resource policy to be deleted.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • policyRevision — (String)

    The current revision of the resource policy to be deleted. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policy — (map)

      Information about the deleted resource policy after processing the request.

      • resourceArn — (String)

        The ARN of the resource associated with the resource policy

      • revision — (String)

        The current revision of the resource policy.

      • document — (String)

        The resource policy formatted in JSON.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo, /* required */
  package: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  namespace: 'STRING_VALUE'
};
codeartifact.deletePackage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the package to delete.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository that contains the package to delete.

  • format — (String)

    The format of the requested package to delete.

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"
  • namespace — (String)

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

    Note: The namespace is required when deleting packages of the following formats:

    • Maven
    • Swift
    • generic

    • The namespace of a Maven package version is its groupId.

    • The namespace of an npm or Swift package version is its scope.

    • The namespace of a generic package is its namespace.

    • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • package — (String)

    The name of the package to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • deletedPackage — (map)

      Details about a package, including its format, namespace, and name.

      • format — (String)

        The format of the package.

        Possible values include:
        • "npm"
        • "pypi"
        • "maven"
        • "nuget"
        • "generic"
        • "ruby"
        • "swift"
        • "cargo"
      • namespace — (String)

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

        • The namespace of a Maven package version is its groupId.

        • The namespace of an npm or Swift package version is its scope.

        • The namespace of a generic package is its namespace.

        • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

      • package — (String)

        The name of the package.

      • originConfiguration — (map)

        A PackageOriginConfiguration object that contains a PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions.

        • restrictions — (map)

          A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.

          • publish — required — (String)

            The package origin configuration that determines if new versions of the package can be published directly to the repository.

            Possible values include:
            • "ALLOW"
            • "BLOCK"
          • upstream — required — (String)

            The package origin configuration that determines if new versions of the package can be added to the repository from an external connection or upstream source.

            Possible values include:
            • "ALLOW"
            • "BLOCK"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  packageGroup: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.deletePackageGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The domain that contains the package group to be deleted.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • packageGroup — (String)

    The pattern of the package group to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • packageGroup — (map)

      Information about the deleted package group after processing the request.

      • arn — (String)

        The ARN of the package group.

      • pattern — (String)

        The pattern of the package group. The pattern determines which packages are associated with the package group.

      • domainName — (String)

        The name of the domain that contains the package group.

      • domainOwner — (String)

        The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

      • createdTime — (Date)

        A timestamp that represents the date and time the package group was created.

      • contactInfo — (String)

        The contact information of the package group.

      • description — (String)

        The description of the package group.

      • originConfiguration — (map)

        The package group origin configuration that determines how package versions can enter repositories.

        • restrictions — (map<map>)

          The origin configuration settings that determine how package versions can enter repositories.

          • mode — (String)

            The package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

            Possible values include:
            • "ALLOW"
            • "ALLOW_SPECIFIC_REPOSITORIES"
            • "BLOCK"
            • "INHERIT"
          • effectiveMode — (String)

            The effective package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value of mode is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

            Possible values include:
            • "ALLOW"
            • "ALLOW_SPECIFIC_REPOSITORIES"
            • "BLOCK"
            • "INHERIT"
          • inheritedFrom — (map)

            The parent package group that the package group origin restrictions are inherited from.

            • arn — (String)

              The ARN of the package group.

            • pattern — (String)

              The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

          • repositoriesCount — (Integer)

            The number of repositories in the allowed repository list.

      • parent — (map)

        The direct parent package group of the package group.

        • arn — (String)

          The ARN of the package group.

        • pattern — (String)

          The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo, /* required */
  package: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  versions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  domainOwner: 'STRING_VALUE',
  expectedStatus: Published | Unfinished | Unlisted | Archived | Disposed | Deleted,
  namespace: 'STRING_VALUE'
};
codeartifact.deletePackageVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the package to delete.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository that contains the package versions to delete.

  • format — (String)

    The format of the package versions to delete.

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"
  • namespace — (String)

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

    Note: The namespace is required when deleting package versions of the following formats:

    • Maven
    • Swift
    • generic

    • The namespace of a Maven package version is its groupId.

    • The namespace of an npm or Swift package version is its scope.

    • The namespace of a generic package is its namespace.

    • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • package — (String)

    The name of the package with the versions to delete.

  • versions — (Array<String>)

    An array of strings that specify the versions of the package to delete.

  • expectedStatus — (String)

    The expected status of the package version to delete.

    Possible values include:
    • "Published"
    • "Unfinished"
    • "Unlisted"
    • "Archived"
    • "Disposed"
    • "Deleted"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • successfulVersions — (map<map>)

      A list of the package versions that were successfully deleted. The status of every successful version will be Deleted.

      • revision — (String)

        The revision of a package version.

      • status — (String)

        The status of a package version.

        Possible values include:
        • "Published"
        • "Unfinished"
        • "Unlisted"
        • "Archived"
        • "Disposed"
        • "Deleted"
    • failedVersions — (map<map>)

      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

      • errorCode — (String)

        The error code associated with the error. Valid error codes are:

        • ALREADY_EXISTS

        • MISMATCHED_REVISION

        • MISMATCHED_STATUS

        • NOT_ALLOWED

        • NOT_FOUND

        • SKIPPED

        Possible values include:
        • "ALREADY_EXISTS"
        • "MISMATCHED_REVISION"
        • "MISMATCHED_STATUS"
        • "NOT_ALLOWED"
        • "NOT_FOUND"
        • "SKIPPED"
      • errorMessage — (String)

        The error message associated with the error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.deleteRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository to delete.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • repository — (map)

      Information about the deleted repository after processing the request.

      • name — (String)

        The name of the repository.

      • administratorAccount — (String)

        The 12-digit account number of the Amazon Web Services account that manages the repository.

      • domainName — (String)

        The name of the domain that contains the repository.

      • domainOwner — (String)

        The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

      • arn — (String)

        The Amazon Resource Name (ARN) of the repository.

      • description — (String)

        A text description of the repository.

      • upstreams — (Array<map>)

        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.

        • repositoryName — (String)

          The name of an upstream repository.

      • externalConnections — (Array<map>)

        An array of external connections associated with the repository.

        • externalConnectionName — (String)

          The name of the external connection associated with a repository.

        • packageFormat — (String)

          The package format associated with a repository's external connection. The valid package formats are:

          • npm: A Node Package Manager (npm) package.

          • pypi: A Python Package Index (PyPI) package.

          • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

          • nuget: A NuGet package.

          Possible values include:
          • "npm"
          • "pypi"
          • "maven"
          • "nuget"
          • "generic"
          • "ruby"
          • "swift"
          • "cargo"
        • status — (String)

          The status of the external connection of a repository. There is one valid value, Available.

          Possible values include:
          • "Available"
      • createdTime — (Date)

        A timestamp that represents the date and time the repository was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  policyRevision: 'STRING_VALUE'
};
codeartifact.deleteRepositoryPermissionsPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository associated with the resource policy to be deleted.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository that is associated with the resource policy to be deleted

  • policyRevision — (String)

    The revision of the repository's resource policy to be deleted. This revision is used for optimistic locking, which prevents others from accidentally overwriting your changes to the repository's resource policy.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policy — (map)

      Information about the deleted policy after processing the request.

      • resourceArn — (String)

        The ARN of the resource associated with the resource policy

      • revision — (String)

        The current revision of the resource policy.

      • document — (String)

        The resource policy formatted in JSON.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.describeDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    A string that specifies the name of the requested domain.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • domain — (map)

      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.

      • name — (String)

        The name of the domain.

      • owner — (String)

        The Amazon Web Services account ID that owns the domain.

      • arn — (String)

        The Amazon Resource Name (ARN) of the domain.

      • status — (String)

        The current status of a domain.

        Possible values include:
        • "Active"
        • "Deleted"
      • createdTime — (Date)

        A timestamp that represents the date and time the domain was created.

      • encryptionKey — (String)

        The ARN of an Key Management Service (KMS) key associated with a domain.

      • repositoryCount — (Integer)

        The number of repositories in the domain.

      • assetSizeBytes — (Integer)

        The total size of all assets in the domain.

      • s3BucketArn — (String)

        The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo, /* required */
  package: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  namespace: 'STRING_VALUE'
};
codeartifact.describePackage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository that contains the package.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository that contains the requested package.

  • format — (String)

    A format that specifies the type of the requested package.

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"
  • namespace — (String)

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

    Note: The namespace is required when requesting packages of the following formats:

    • Maven
    • Swift
    • generic

    • The namespace of a Maven package version is its groupId.

    • The namespace of an npm or Swift package version is its scope.

    • The namespace of a generic package is its namespace.

    • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • package — (String)

    The name of the requested package.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • package — (map)

      A PackageDescription object that contains information about the requested package.

      • format — (String)

        A format that specifies the type of the package.

        Possible values include:
        • "npm"
        • "pypi"
        • "maven"
        • "nuget"
        • "generic"
        • "ruby"
        • "swift"
        • "cargo"
      • namespace — (String)

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

        • The namespace of a Maven package version is its groupId.

        • The namespace of an npm or Swift package version is its scope.

        • The namespace of a generic package is its namespace.

        • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

      • name — (String)

        The name of the package.

      • originConfiguration — (map)

        The package origin configuration for the package.

        • restrictions — (map)

          A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.

          • publish — required — (String)

            The package origin configuration that determines if new versions of the package can be published directly to the repository.

            Possible values include:
            • "ALLOW"
            • "BLOCK"
          • upstream — required — (String)

            The package origin configuration that determines if new versions of the package can be added to the repository from an external connection or upstream source.

            Possible values include:
            • "ALLOW"
            • "BLOCK"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  packageGroup: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.describePackageGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the package group.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • packageGroup — (String)

    The pattern of the requested package group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • packageGroup — (map)

      A PackageGroupDescription object that contains information about the requested package group.

      • arn — (String)

        The ARN of the package group.

      • pattern — (String)

        The pattern of the package group. The pattern determines which packages are associated with the package group.

      • domainName — (String)

        The name of the domain that contains the package group.

      • domainOwner — (String)

        The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

      • createdTime — (Date)

        A timestamp that represents the date and time the package group was created.

      • contactInfo — (String)

        The contact information of the package group.

      • description — (String)

        The description of the package group.

      • originConfiguration — (map)

        The package group origin configuration that determines how package versions can enter repositories.

        • restrictions — (map<map>)

          The origin configuration settings that determine how package versions can enter repositories.

          • mode — (String)

            The package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

            Possible values include:
            • "ALLOW"
            • "ALLOW_SPECIFIC_REPOSITORIES"
            • "BLOCK"
            • "INHERIT"
          • effectiveMode — (String)

            The effective package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value of mode is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

            Possible values include:
            • "ALLOW"
            • "ALLOW_SPECIFIC_REPOSITORIES"
            • "BLOCK"
            • "INHERIT"
          • inheritedFrom — (map)

            The parent package group that the package group origin restrictions are inherited from.

            • arn — (String)

              The ARN of the package group.

            • pattern — (String)

              The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

          • repositoriesCount — (Integer)

            The number of repositories in the allowed repository list.

      • parent — (map)

        The direct parent package group of the package group.

        • arn — (String)

          The ARN of the package group.

        • pattern — (String)

          The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo, /* required */
  package: 'STRING_VALUE', /* required */
  packageVersion: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  namespace: 'STRING_VALUE'
};
codeartifact.describePackageVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository that contains the package version.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository that contains the package version.

  • format — (String)

    A format that specifies the type of the requested package version.

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"
  • namespace — (String)

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

    Note: The namespace is required when requesting package versions of the following formats:

    • Maven
    • Swift
    • generic

    • The namespace of a Maven package version is its groupId.

    • The namespace of an npm or Swift package version is its scope.

    • The namespace of a generic package is its namespace.

    • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • package — (String)

    The name of the requested package version.

  • packageVersion — (String)

    A string that contains the package version (for example, 3.5.2).

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • packageVersion — (map)

      A PackageVersionDescription object that contains information about the requested package version.

      • format — (String)

        The format of the package version.

        Possible values include:
        • "npm"
        • "pypi"
        • "maven"
        • "nuget"
        • "generic"
        • "ruby"
        • "swift"
        • "cargo"
      • namespace — (String)

        The namespace of the package version. The package 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 or Swift package version is its scope.

        • The namespace of a generic package is its namespace.

        • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

      • packageName — (String)

        The name of the requested package.

      • displayName — (String)

        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.

      • version — (String)

        The version of the package.

      • summary — (String)

        A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.

      • homePage — (String)

        The homepage associated with the package.

      • sourceCodeRepository — (String)

        The repository for the source code in the package version, or the source code used to build it.

      • publishedTime — (Date)

        A timestamp that contains the date and time the package version was published.

      • licenses — (Array<map>)

        Information about licenses associated with the package version.

        • name — (String)

          Name of the license.

        • url — (String)

          The URL for license data.

      • revision — (String)

        The revision of the package version.

      • status — (String)

        A string that contains the status of the package version.

        Possible values include:
        • "Published"
        • "Unfinished"
        • "Unlisted"
        • "Archived"
        • "Disposed"
        • "Deleted"
      • origin — (map)

        A PackageVersionOrigin object that contains information about how the package version was added to the repository.

        • domainEntryPoint — (map)

          A DomainEntryPoint object that contains information about from which repository or external connection the package version was added to the domain.

          • repositoryName — (String)

            The name of the repository that a package was originally published to.

          • externalConnectionName — (String)

            The name of the external connection that a package was ingested from.

        • originType — (String)

          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.

          Possible values include:
          • "INTERNAL"
          • "EXTERNAL"
          • "UNKNOWN"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.describeRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository to describe.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    A string that specifies the name of the requested repository.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • repository — (map)

      A RepositoryDescription object that contains the requested repository information.

      • name — (String)

        The name of the repository.

      • administratorAccount — (String)

        The 12-digit account number of the Amazon Web Services account that manages the repository.

      • domainName — (String)

        The name of the domain that contains the repository.

      • domainOwner — (String)

        The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

      • arn — (String)

        The Amazon Resource Name (ARN) of the repository.

      • description — (String)

        A text description of the repository.

      • upstreams — (Array<map>)

        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.

        • repositoryName — (String)

          The name of an upstream repository.

      • externalConnections — (Array<map>)

        An array of external connections associated with the repository.

        • externalConnectionName — (String)

          The name of the external connection associated with a repository.

        • packageFormat — (String)

          The package format associated with a repository's external connection. The valid package formats are:

          • npm: A Node Package Manager (npm) package.

          • pypi: A Python Package Index (PyPI) package.

          • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

          • nuget: A NuGet package.

          Possible values include:
          • "npm"
          • "pypi"
          • "maven"
          • "nuget"
          • "generic"
          • "ruby"
          • "swift"
          • "cargo"
        • status — (String)

          The status of the external connection of a repository. There is one valid value, Available.

          Possible values include:
          • "Available"
      • createdTime — (Date)

        A timestamp that represents the date and time the repository was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  externalConnection: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.disassociateExternalConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository from which to remove the external repository.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository from which the external connection will be removed.

  • externalConnection — (String)

    The name of the external connection to be removed from the repository.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • repository — (map)

      The repository associated with the removed external connection.

      • name — (String)

        The name of the repository.

      • administratorAccount — (String)

        The 12-digit account number of the Amazon Web Services account that manages the repository.

      • domainName — (String)

        The name of the domain that contains the repository.

      • domainOwner — (String)

        The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

      • arn — (String)

        The Amazon Resource Name (ARN) of the repository.

      • description — (String)

        A text description of the repository.

      • upstreams — (Array<map>)

        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.

        • repositoryName — (String)

          The name of an upstream repository.

      • externalConnections — (Array<map>)

        An array of external connections associated with the repository.

        • externalConnectionName — (String)

          The name of the external connection associated with a repository.

        • packageFormat — (String)

          The package format associated with a repository's external connection. The valid package formats are:

          • npm: A Node Package Manager (npm) package.

          • pypi: A Python Package Index (PyPI) package.

          • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

          • nuget: A NuGet package.

          Possible values include:
          • "npm"
          • "pypi"
          • "maven"
          • "nuget"
          • "generic"
          • "ruby"
          • "swift"
          • "cargo"
        • status — (String)

          The status of the external connection of a repository. There is one valid value, Available.

          Possible values include:
          • "Available"
      • createdTime — (Date)

        A timestamp that represents the date and time the repository was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo, /* required */
  package: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  versions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  domainOwner: 'STRING_VALUE',
  expectedStatus: Published | Unfinished | Unlisted | Archived | Disposed | Deleted,
  namespace: 'STRING_VALUE',
  versionRevisions: {
    '<PackageVersion>': 'STRING_VALUE',
    /* '<PackageVersion>': ... */
  }
};
codeartifact.disposePackageVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository you want to dispose.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository that contains the package versions you want to dispose.

  • format — (String)

    A format that specifies the type of package versions you want to dispose.

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"
  • namespace — (String)

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

    Note: The namespace is required when disposing package versions of the following formats:

    • Maven
    • Swift
    • generic

    • The namespace of a Maven package version is its groupId.

    • The namespace of an npm or Swift package version is its scope.

    • The namespace of a generic package is its namespace.

    • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • package — (String)

    The name of the package with the versions you want to dispose.

  • versions — (Array<String>)

    The versions of the package you want to dispose.

  • versionRevisions — (map<String>)

    The revisions of the package versions you want to dispose.

  • expectedStatus — (String)

    The expected status of the package version to dispose.

    Possible values include:
    • "Published"
    • "Unfinished"
    • "Unlisted"
    • "Archived"
    • "Disposed"
    • "Deleted"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • successfulVersions — (map<map>)

      A list of the package versions that were successfully disposed.

      • revision — (String)

        The revision of a package version.

      • status — (String)

        The status of a package version.

        Possible values include:
        • "Published"
        • "Unfinished"
        • "Unlisted"
        • "Archived"
        • "Disposed"
        • "Deleted"
    • failedVersions — (map<map>)

      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

      • errorCode — (String)

        The error code associated with the error. Valid error codes are:

        • ALREADY_EXISTS

        • MISMATCHED_REVISION

        • MISMATCHED_STATUS

        • NOT_ALLOWED

        • NOT_FOUND

        • SKIPPED

        Possible values include:
        • "ALREADY_EXISTS"
        • "MISMATCHED_REVISION"
        • "MISMATCHED_STATUS"
        • "NOT_ALLOWED"
        • "NOT_FOUND"
        • "SKIPPED"
      • errorMessage — (String)

        The error message associated with the error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo, /* required */
  package: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  namespace: 'STRING_VALUE'
};
codeartifact.getAssociatedPackageGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the package from which to get the associated package group.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • format — (String)

    The format of the package from which to get the associated package group.

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"
  • namespace — (String)

    The namespace of the package from which to get the associated package group. The package component that specifies its namespace depends on its type. For example:

    Note: The namespace is required when getting associated package groups from packages of the following formats:

    • Maven
    • Swift
    • generic

    • The namespace of a Maven package version is its groupId.

    • The namespace of an npm or Swift package version is its scope.

    • The namespace of a generic package is its namespace.

    • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • package — (String)

    The package from which to get the associated package group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • packageGroup — (map)

      The package group that is associated with the requested package.

      • arn — (String)

        The ARN of the package group.

      • pattern — (String)

        The pattern of the package group. The pattern determines which packages are associated with the package group.

      • domainName — (String)

        The name of the domain that contains the package group.

      • domainOwner — (String)

        The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

      • createdTime — (Date)

        A timestamp that represents the date and time the package group was created.

      • contactInfo — (String)

        The contact information of the package group.

      • description — (String)

        The description of the package group.

      • originConfiguration — (map)

        The package group origin configuration that determines how package versions can enter repositories.

        • restrictions — (map<map>)

          The origin configuration settings that determine how package versions can enter repositories.

          • mode — (String)

            The package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

            Possible values include:
            • "ALLOW"
            • "ALLOW_SPECIFIC_REPOSITORIES"
            • "BLOCK"
            • "INHERIT"
          • effectiveMode — (String)

            The effective package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value of mode is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

            Possible values include:
            • "ALLOW"
            • "ALLOW_SPECIFIC_REPOSITORIES"
            • "BLOCK"
            • "INHERIT"
          • inheritedFrom — (map)

            The parent package group that the package group origin restrictions are inherited from.

            • arn — (String)

              The ARN of the package group.

            • pattern — (String)

              The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

          • repositoriesCount — (Integer)

            The number of repositories in the allowed repository list.

      • parent — (map)

        The direct parent package group of the package group.

        • arn — (String)

          The ARN of the package group.

        • pattern — (String)

          The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

    • associationType — (String)

      Describes the strength of the association between the package and package group. A strong match is also known as an exact match, and a weak match is known as a relative match.

      Possible values include:
      • "STRONG"
      • "WEAK"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  durationSeconds: 'NUMBER_VALUE'
};
codeartifact.getAuthorizationToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that is in scope for the generated authorization token.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • durationSeconds — (Integer)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • authorizationToken — (String)

      The returned authentication token.

    • expiration — (Date)

      A timestamp that specifies the date and time the authorization token expires.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.getDomainPermissionsPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain to which the resource policy is attached.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policy — (map)

      The returned resource policy.

      • resourceArn — (String)

        The ARN of the resource associated with the resource policy

      • revision — (String)

        The current revision of the resource policy.

      • document — (String)

        The resource policy formatted in JSON.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  asset: 'STRING_VALUE', /* required */
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo, /* required */
  package: 'STRING_VALUE', /* required */
  packageVersion: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  namespace: 'STRING_VALUE',
  packageVersionRevision: 'STRING_VALUE'
};
codeartifact.getPackageVersionAsset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository that contains the package version with the requested asset.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The repository that contains the package version with the requested asset.

  • format — (String)

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

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"
  • namespace — (String)

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

    Note: The namespace is required when requesting assets from package versions of the following formats:

    • Maven
    • Swift
    • generic

    • The namespace of a Maven package version is its groupId.

    • The namespace of an npm or Swift package version is its scope.

    • The namespace of a generic package is its namespace.

    • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • package — (String)

    The name of the package that contains the requested asset.

  • packageVersion — (String)

    A string that contains the package version (for example, 3.5.2).

  • asset — (String)

    The name of the requested asset.

  • packageVersionRevision — (String)

    The name of the package version revision that contains the requested asset.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • asset — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

      The binary file, or asset, that is downloaded.

    • assetName — (String)

      The name of the asset that is downloaded.

    • packageVersion — (String)

      A string that contains the package version (for example, 3.5.2).

    • packageVersionRevision — (String)

      The name of the package version revision that contains the downloaded asset.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo, /* required */
  package: 'STRING_VALUE', /* required */
  packageVersion: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  namespace: 'STRING_VALUE'
};
codeartifact.getPackageVersionReadme(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository that contains the package version with the requested readme file.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The repository that contains the package with the requested readme file.

  • format — (String)

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

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"
  • namespace — (String)

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

    Note: The namespace is required when requesting the readme from package versions of the following formats:

    • Maven
    • Swift
    • generic

    • The namespace of a Maven package version is its groupId.

    • The namespace of an npm or Swift package version is its scope.

    • The namespace of a generic package is its namespace.

    • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • package — (String)

    The name of the package version that contains the requested readme file.

  • packageVersion — (String)

    A string that contains the package version (for example, 3.5.2).

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • format — (String)

      The format of the package with the requested readme file.

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
      • "generic"
      • "ruby"
      • "swift"
      • "cargo"
    • namespace — (String)

      The namespace of the package version with the requested readme file. The package 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 or Swift package version is its scope.

      • The namespace of a generic package is its namespace.

      • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

    • package — (String)

      The name of the package that contains the returned readme file.

    • version — (String)

      The version of the package with the requested readme file.

    • versionRevision — (String)

      The current revision associated with the package version.

    • readme — (String)

      The text of the returned readme file.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo, /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.getRepositoryEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository.

  • format — (String)

    Returns which endpoint of a repository to return. A repository has one endpoint for each package format.

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • repositoryEndpoint — (String)

      A string that specifies the URL of the returned endpoint.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.getRepositoryPermissionsPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain containing the repository whose associated resource policy is to be retrieved.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository whose associated resource policy is to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policy — (map)

      The returned resource policy.

      • resourceArn — (String)

        The ARN of the resource associated with the resource policy

      • revision — (String)

        The current revision of the resource policy.

      • document — (String)

        The resource policy formatted in JSON.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  originRestrictionType: EXTERNAL_UPSTREAM | INTERNAL_UPSTREAM | PUBLISH, /* required */
  packageGroup: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codeartifact.listAllowedRepositoriesForGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the package group from which to list allowed repositories.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • packageGroup — (String)

    The pattern of the package group from which to list allowed repositories.

  • originRestrictionType — (String)

    The origin configuration restriction type of which to list allowed repositories.

    Possible values include:
    • "EXTERNAL_UPSTREAM"
    • "INTERNAL_UPSTREAM"
    • "PUBLISH"
  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • allowedRepositories — (Array<String>)

      The list of allowed repositories for the package group and origin configuration restriction type.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  packageGroup: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  preview: true || false
};
codeartifact.listAssociatedPackages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the package group from which to list associated packages.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • packageGroup — (String)

    The pattern of the package group from which to list associated packages.

  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • preview — (Boolean)

    When this flag is included, ListAssociatedPackages will return a list of packages that would be associated with a package group, even if it does not exist.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • packages — (Array<map>)

      The list of packages associated with the requested package group.

      • format — (String)

        A format that specifies the type of the associated package.

        Possible values include:
        • "npm"
        • "pypi"
        • "maven"
        • "nuget"
        • "generic"
        • "ruby"
        • "swift"
        • "cargo"
      • namespace — (String)

        The namespace of the associated package. The package 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 or Swift package version is its scope.

        • The namespace of a generic package is its namespace.

        • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

      • package — (String)

        The name of the associated package.

      • associationType — (String)

        Describes the strength of the association between the package and package group. A strong match can be thought of as an exact match, and a weak match can be thought of as a variation match, for example, the package name matches a variation of the package group pattern. For more information about package group pattern matching, including strong and weak matches, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

        Possible values include:
        • "STRONG"
        • "WEAK"
    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codeartifact.listDomains(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • domains — (Array<map>)

      The returned list of DomainSummary objects.

      • name — (String)

        The name of the domain.

      • owner — (String)

        The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

      • arn — (String)

        The ARN of the domain.

      • status — (String)

        A string that contains the status of the domain.

        Possible values include:
        • "Active"
        • "Deleted"
      • createdTime — (Date)

        A timestamp that contains the date and time the domain was created.

      • encryptionKey — (String)

        The key used to encrypt the domain.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  prefix: 'STRING_VALUE'
};
codeartifact.listPackageGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The domain for which you want to list package groups.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • prefix — (String)

    A prefix for which to search package groups. When included, ListPackageGroups will return only package groups with patterns that match the prefix.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • packageGroups — (Array<map>)

      The list of package groups in the requested domain.

      • arn — (String)

        The ARN of the package group.

      • pattern — (String)

        The pattern of the package group. The pattern determines which packages are associated with the package group.

      • domainName — (String)

        The domain that contains the package group.

      • domainOwner — (String)

        The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

      • createdTime — (Date)

        A timestamp that represents the date and time the repository was created.

      • contactInfo — (String)

        The contact information of the package group.

      • description — (String)

        The description of the package group.

      • originConfiguration — (map)

        Details about the package origin configuration of a package group.

        • restrictions — (map<map>)

          The origin configuration settings that determine how package versions can enter repositories.

          • mode — (String)

            The package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

            Possible values include:
            • "ALLOW"
            • "ALLOW_SPECIFIC_REPOSITORIES"
            • "BLOCK"
            • "INHERIT"
          • effectiveMode — (String)

            The effective package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value of mode is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.

            Possible values include:
            • "ALLOW"
            • "ALLOW_SPECIFIC_REPOSITORIES"
            • "BLOCK"
            • "INHERIT"
          • inheritedFrom — (map)

            The parent package group that the package group origin restrictions are inherited from.

            • arn — (String)

              The ARN of the package group.

            • pattern — (String)

              The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

          • repositoriesCount — (Integer)

            The number of repositories in the allowed repository list.

      • parent — (map)

        The direct parent package group of the package group.

        • arn — (String)

          The ARN of the package group.

        • pattern — (String)

          The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo,
  maxResults: 'NUMBER_VALUE',
  namespace: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  packagePrefix: 'STRING_VALUE',
  publish: ALLOW | BLOCK,
  upstream: ALLOW | BLOCK
};
codeartifact.listPackages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository that contains the requested packages.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository that contains the requested packages.

  • format — (String)

    The format used to filter requested packages. Only packages from the provided format will be returned.

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"
  • namespace — (String)

    The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior.

    Each package format uses namespace as follows:

    • The namespace of a Maven package version is its groupId.

    • The namespace of an npm or Swift package version is its scope.

    • The namespace of a generic package is its namespace.

    • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • packagePrefix — (String)

    A prefix used to filter requested packages. Only packages with names that start with packagePrefix are returned.

  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • publish — (String)

    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.

    Possible values include:
    • "ALLOW"
    • "BLOCK"
  • upstream — (String)

    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.

    Possible values include:
    • "ALLOW"
    • "BLOCK"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • packages — (Array<map>)

      The list of returned PackageSummary objects.

      • format — (String)

        The format of the package.

        Possible values include:
        • "npm"
        • "pypi"
        • "maven"
        • "nuget"
        • "generic"
        • "ruby"
        • "swift"
        • "cargo"
      • namespace — (String)

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

        • The namespace of a Maven package version is its groupId.

        • The namespace of an npm or Swift package version is its scope.

        • The namespace of a generic package is its namespace.

        • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

      • package — (String)

        The name of the package.

      • originConfiguration — (map)

        A PackageOriginConfiguration object that contains a PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions.

        • restrictions — (map)

          A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.

          • publish — required — (String)

            The package origin configuration that determines if new versions of the package can be published directly to the repository.

            Possible values include:
            • "ALLOW"
            • "BLOCK"
          • upstream — required — (String)

            The package origin configuration that determines if new versions of the package can be added to the repository from an external connection or upstream source.

            Possible values include:
            • "ALLOW"
            • "BLOCK"
    • nextToken — (String)

      If there are additional results, this is the token for the next set of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo, /* required */
  package: 'STRING_VALUE', /* required */
  packageVersion: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  namespace: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
codeartifact.listPackageVersionAssets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository associated with the package version assets.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository that contains the package that contains the requested package version assets.

  • format — (String)

    The format of the package that contains the requested package version assets.

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"
  • namespace — (String)

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

    Note: The namespace is required requesting assets from package versions of the following formats:

    • Maven
    • Swift
    • generic

    • The namespace of a Maven package version is its groupId.

    • The namespace of an npm or Swift package version is its scope.

    • The namespace of a generic package is its namespace.

    • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • package — (String)

    The name of the package that contains the requested package version assets.

  • packageVersion — (String)

    A string that contains the package version (for example, 3.5.2).

  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • format — (String)

      The format of the package that contains the requested package version assets.

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
      • "generic"
      • "ruby"
      • "swift"
      • "cargo"
    • namespace — (String)

      The namespace of the package version that contains the requested package version assets. The package 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 or Swift package version is its scope.

      • The namespace of a generic package is its namespace.

      • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

    • package — (String)

      The name of the package that contains the requested package version assets.

    • version — (String)

      The version of the package associated with the requested assets.

    • versionRevision — (String)

      The current revision associated with the package version.

    • nextToken — (String)

      If there are additional results, this is the token for the next set of results.

    • assets — (Array<map>)

      The returned list of AssetSummary objects.

      • name — required — (String)

        The name of the asset.

      • size — (Integer)

        The size of the asset.

      • hashes — (map<String>)

        The hashes of the asset.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo, /* required */
  package: 'STRING_VALUE', /* required */
  packageVersion: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  namespace: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
codeartifact.listPackageVersionDependencies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository that contains the requested package version dependencies.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository that contains the requested package version.

  • format — (String)

    The format of the package with the requested dependencies.

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"
  • namespace — (String)

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

    Note: The namespace is required when listing dependencies from package versions of the following formats:

    • Maven

    • The namespace of a Maven package version is its groupId.

    • The namespace of an npm package version is its scope.

    • Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • package — (String)

    The name of the package versions' package.

  • packageVersion — (String)

    A string that contains the package version (for example, 3.5.2).

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • format — (String)

      A format that specifies the type of the package that contains the returned dependencies.

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
      • "generic"
      • "ruby"
      • "swift"
      • "cargo"
    • namespace — (String)

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

      Note: The namespace is required when listing dependencies from package versions of the following formats:

      • Maven

      • The namespace of a Maven package version is its groupId.

      • The namespace of an npm package version is its scope.

      • Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

    • package — (String)

      The name of the package that contains the returned package versions dependencies.

    • version — (String)

      The version of the package that is specified in the request.

    • versionRevision — (String)

      The current revision associated with the package version.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • dependencies — (Array<map>)

      The returned list of PackageDependency objects.

      • namespace — (String)

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

        • The namespace of a Maven package version is its groupId.

        • The namespace of an npm or Swift package version is its scope.

        • The namespace of a generic package is its namespace.

        • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

      • package — (String)

        The name of the package that this package depends on.

      • dependencyType — (String)

        The type of a package dependency. The possible values depend on the package type.

        • npm: regular, dev, peer, optional

        • maven: optional, parent, compile, runtime, test, system, provided.

          Note: 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

      • versionRequirement — (String)

        The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget | generic | ruby | swift | cargo, /* required */
  package: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  namespace: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  originType: INTERNAL | EXTERNAL | UNKNOWN,
  sortBy: PUBLISHED_TIME,
  status: Published | Unfinished | Unlisted | Archived | Disposed | Deleted
};
codeartifact.listPackageVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domain — (String)

    The name of the domain that contains the repository that contains the requested package versions.

  • domainOwner — (String)

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository — (String)

    The name of the repository that contains the requested package versions.

  • format — (String)

    The format of the package versions you want to list.

    Possible values include:
    • "npm"
    • "pypi"
    • "maven"
    • "nuget"
    • "generic"
    • "ruby"
    • "swift"
    • "cargo"
  • namespace — (String)

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

    Note: The namespace is required when deleting package versions of the following formats:

    • Maven
    • Swift
    • generic

    • The namespace of a Maven package version is its groupId.

    • The namespace of an npm or Swift package version is its scope.

    • The namespace of a generic package is its namespace.

    • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • package — (String)

    The name of the package for which you want to request package versions.

  • status — (String)

    A string that filters the requested package versions by status.

    Possible values include:
    • "Published"
    • "Unfinished"
    • "Unlisted"
    • "Archived"
    • "Disposed"
    • "Deleted"
  • sortBy — (String)

    How to sort the requested list of package versions.

    Possible values include:
    • "PUBLISHED_TIME"
  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • originType — (String)

    The originType used to filter package versions. Only package versions with the provided originType will be returned.

    Possible values include:
    • "INTERNAL"
    • "EXTERNAL"
    • "UNKNOWN"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • defaultDisplayVersion — (String)

      The default package version to display. This depends on the package format:

      • For Maven and PyPI packages, it's the most recently published package version.

      • For npm packages, it's the version referenced by the latest tag. If the latest tag is not set, it's the most recently published package version.

    • format — (String)

      A format of the package.

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
      • "generic"
      • "ruby"
      • "swift"
      • "cargo"
    • namespace — (String)

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

      • The namespace of a Maven package version is its groupId.

      • The namespace of an npm or Swift package version is its scope.

      • The namespace of a generic package is its namespace.

      • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

    • package — (String)

      The name of the package.

    • versions — (Array<map>)

      The returned list of PackageVersionSummary objects.

      • version — required — (String)

        Information about a package version.

      • revision — (String)

        The revision associated with a package version.

      • status — required — (String)

        A string that contains the status of the package version. It can be one of the following:

        Possible values include:
        • "Published"
        • "Unfinished"
        • "Unlisted"
        • "Archived"
        • "Disposed"
        • "Deleted"
      • origin — (map)

        A PackageVersionOrigin object that contains information about how the package version was added to the repository.

        • domainEntryPoint — (map)

          A DomainEntryPoint object that contains information about from which repository or external connection the package version was added to the domain.

          • repositoryName — (String)

            The name of the repository that a package was originally published to.

          • externalConnectionName — (String)

            The name of the external connection that a package was ingested from.

        • originType — (String)

          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.

          Possible values include:
          • "INTERNAL"
          • "EXTERNAL"
          • "UNKNOWN"
    • nextToken — (String)

      If there are additional results, this is the token for the next set of results.