/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CodeArtifact::GetPackageVersionReadme

NAME

Paws::CodeArtifact::GetPackageVersionReadme - Arguments for method GetPackageVersionReadme on Paws::CodeArtifact

DESCRIPTION

This class represents the parameters used for calling the method GetPackageVersionReadme on the CodeArtifact service. Use the attributes of this class as arguments to method GetPackageVersionReadme.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetPackageVersionReadme.

SYNOPSIS

my $codeartifact = Paws->service('CodeArtifact');
my $GetPackageVersionReadmeResult = $codeartifact->GetPackageVersionReadme(
  Domain         => 'MyDomainName',
  Format         => 'npm',
  Package        => 'MyPackageName',
  PackageVersion => 'MyPackageVersion',
  Repository     => 'MyRepositoryName',
  DomainOwner    => 'MyAccountId',           # OPTIONAL
  Namespace      => 'MyPackageNamespace',    # OPTIONAL
);

# Results:
my $Format          = $GetPackageVersionReadmeResult->Format;
my $Namespace       = $GetPackageVersionReadmeResult->Namespace;
my $Package         = $GetPackageVersionReadmeResult->Package;
my $Readme          = $GetPackageVersionReadmeResult->Readme;
my $Version         = $GetPackageVersionReadmeResult->Version;
my $VersionRevision = $GetPackageVersionReadmeResult->VersionRevision;

# Returns a L<Paws::CodeArtifact::GetPackageVersionReadmeResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codeartifact/GetPackageVersionReadme

ATTRIBUTES

REQUIRED Domain => Str

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

DomainOwner => Str

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

REQUIRED Format => Str

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

  • npm

  • pypi

  • maven

Valid values are: "npm", "pypi", "maven", "nuget"

Namespace => Str

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.

REQUIRED Package => Str

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

REQUIRED PackageVersion => Str

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

REQUIRED Repository => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method GetPackageVersionReadme in Paws::CodeArtifact

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues