AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the GetPackageVersionReadme operation. Gets the readme file or descriptive text for a package version.

The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CodeArtifact.AmazonCodeArtifactRequest
      Amazon.CodeArtifact.Model.GetPackageVersionReadmeRequest

Namespace: Amazon.CodeArtifact.Model
Assembly: AWSSDK.CodeArtifact.dll
Version: 3.x.y.z

Syntax

C# 
public class GetPackageVersionReadmeRequest : AmazonCodeArtifactRequest
         IAmazonWebServiceRequest

The GetPackageVersionReadmeRequest type exposes the following members

Constructors

NameDescription
Public Method GetPackageVersionReadmeRequest()

Properties

NameTypeDescription
Public Property Domain System.String

Gets and sets the property Domain.

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

Public Property DomainOwner System.String

Gets and sets the property DomainOwner.

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

Public Property Format Amazon.CodeArtifact.PackageFormat

Gets and sets the property Format.

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

Public Property Namespace System.String

Gets and sets the property Namespace.

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 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 and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

Public Property Package System.String

Gets and sets the property Package.

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

Public Property PackageVersion System.String

Gets and sets the property PackageVersion.

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

Public Property Repository System.String

Gets and sets the property Repository.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5