Class: Aws::CodeArtifact::Types::GetPackageVersionReadmeRequest

Inherits:

Struct

• Object
• Struct
• Aws::CodeArtifact::Types::GetPackageVersionReadmeRequest

Includes:

Structure

Defined in:

lib/aws-sdk-codeartifact/types.rb

Overview

Note:

When making an API call, you may pass GetPackageVersionReadmeRequest data as a hash:

{
  domain: "DomainName", # required
  domain_owner: "AccountId",
  repository: "RepositoryName", # required
  format: "npm", # required, accepts npm, pypi, maven, nuget
  namespace: "PackageNamespace",
  package: "PackageName", # required
  package_version: "PackageVersion", # required
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #domain ⇒ String

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

• #domain_owner ⇒ String

  The 12-digit account number of the AWS account that owns the domain.

• #format ⇒ String

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

• #namespace ⇒ String

  The namespace of the package.

• #package ⇒ String

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

• #package_version ⇒ String

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

• #repository ⇒ String

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

Instance Attribute Details

#domain ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 1491

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end

#domain_owner ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 1491

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

A format that specifies the type of the package version with the requested readme file. The valid values are:

• `npm`

• `pypi`

• `maven`

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 1491

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end

#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 is its `groupId`.

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

• A Python package does not contain a corresponding component, so Python packages do not have a namespace.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 1491

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end

#package ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 1491

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end

#package_version ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 1491

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end

#repository ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 1491

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end