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

Inherits:
Struct
  • Object
show all
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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 1430

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 Amazon Web Services account that owns the domain. It does not include dashes or spaces.

Returns:

  • (String) 


1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 1430

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.

<note markdown=“1”> Although `maven` is listed as a valid value, CodeArtifact does not support displaying readme files for Maven packages.

</note>

Returns:

  • (String) 


1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 1430

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) 


1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 1430

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) 


1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 1430

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) 


1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 1430

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) 


1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 1430

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