Skip to content
AWS for Query.Farm

aws.codeartifact.get_package_version_readme

Example SQL Queries

SELECT * FROM
aws.codeartifact.get_package_version_readme
WHERE
"domain" = 'VALUE'
AND "repository" = 'VALUE'
AND "format" = 'VALUE'
AND "package" = 'VALUE'
AND "package_version" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
domain Required Input Column

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

VARCHAR
format Required Input Column

The format of the package with the requested readme file. 

VARCHAR
package Required Input Column

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

VARCHAR
package_version Required Input Column

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

VARCHAR
repository Required Input Column

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

VARCHAR
domain_owner Input Column

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

VARCHAR
namespace Input Column

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. 

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
readme

The text of the returned readme file. 

VARCHAR
version

The version of the package with the requested readme file. 

VARCHAR
version_revision

The current revision associated with the package version. 

VARCHAR