package codeartifact
import "github.com/aws/aws-sdk-go-v2/service/codeartifact"
Package codeartifact provides the API client, operations, and parameter types for CodeArtifact.
AWS CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, and pip. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client. AWS CodeArtifact Components Use the information in this guide to help you work with the following CodeArtifact components:
- Repository: A CodeArtifact repository contains a set of
package versions (https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version), each of which maps to a set of assets, or files. Repositories are polyglot, so a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the npm CLI, the Maven CLI ( mvn ), and pip . You can create up to 100 repositories per AWS account.
- Domain: Repositories are aggregated into a higher-level
entity known as a domain. All package assets and metadata are stored in the domain, but are consumed through repositories. A given package asset, such as a Maven JAR file, is stored once per domain, no matter how many repositories it's present in. All of the assets and metadata in a domain are encrypted with the same customer master key (CMK) stored in AWS Key Management Service (AWS KMS). Each repository is a member of a single domain and can't be moved to a different domain. The domain allows organizational policy to be applied across multiple repositories, such as which accounts can access repositories in the domain, and which public repositories can be used as sources of packages. Although an organization can have multiple domains, we recommend a single production domain that contains all published artifacts so that teams can find and share packages across their organization.
- Package: A package is a bundle of software and
the metadata required to resolve dependencies and install the software. CodeArtifact supports npm (https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html), PyPI (https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html), and Maven (https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven) package formats.
In CodeArtifact, a package consists of: * A name (for
example, webpack is the name of a popular npm package)
- An optional
namespace (for example, @types in @types/node)
- A set of versions (for
example, 1.0.0, 1.0.1, 1.0.2, etc.)
- Package-level metadata (for
example, npm tags)
- Package version: A version of a package, such as
@types/node 12.6.9. The version number format and semantics vary for different package formats. For example, npm package versions must conform to the Semantic Versioning specification (https://semver.org/). In CodeArtifact, a package version consists of the version identifier, metadata at the package version level, and a set of assets.
- Upstream repository: One repository is
upstream of another when the package versions in it can be accessed from the repository endpoint of the downstream repository, effectively merging the contents of the two repositories from the point of view of a client. CodeArtifact allows creating an upstream relationship between two repositories.
- Asset: An individual file stored in CodeArtifact associated
with a package version, such as an npm .tgz file or Maven POM and JAR files.
CodeArtifact supports these operations:
*
AssociateExternalConnection: Adds an existing external connection to a repository.
- CopyPackageVersions: Copies package versions from one
repository to another repository in the same domain.
- CreateDomain:
Creates a domain
- CreateRepository: Creates a CodeArtifact repository in a
domain.
- DeleteDomain: Deletes a domain. You cannot delete a domain that
contains repositories.
- DeleteDomainPermissionsPolicy: Deletes the
resource policy that is set on a domain.
- DeletePackageVersions: Deletes
versions of a package. After a package has been deleted, it can be republished, but its assets and metadata cannot be restored because they have been permanently removed from storage.
- DeleteRepository: Deletes a
repository.
- DeleteRepositoryPermissionsPolicy: Deletes the resource
policy that is set on a repository.
- DescribeDomain: Returns a
DomainDescription object that contains information about the requested domain.
* DescribePackageVersion: Returns a PackageVersionDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) object that contains details about a package version.
- DescribeRepository:
Returns a RepositoryDescription object that contains detailed information about the requested repository.
- DisposePackageVersions: Disposes versions of a
package. A package version with the status Disposed cannot be restored because they have been permanently removed from storage.
*
DisassociateExternalConnection: Removes an existing external connection from a repository.
- GetAuthorizationToken: Generates a temporary authorization
token for accessing repositories in the domain. The token expires the authorization period has passed. The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.
*
GetDomainPermissionsPolicy: Returns the policy of a resource that is attached to the specified domain.
- GetPackageVersionAsset: Returns the contents of an
asset that is in a package version.
- GetPackageVersionReadme: Gets the
readme file or descriptive text for a package version.
*
GetRepositoryEndpoint: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
* npm
pypi
maven
GetRepositoryPermissionsPolicy:
Returns the resource policy that is set on a repository.
- ListDomains:
Returns a list of DomainSummary objects. Each returned DomainSummary object contains information about a domain.
- ListPackages: Lists the packages in
a repository.
- ListPackageVersionAssets: Lists the assets for a given
package version.
- ListPackageVersionDependencies: Returns a list of the
direct dependencies for a package version.
- ListPackageVersions: Returns a
list of package versions for a specified package in a repository.
*
ListRepositories: Returns a list of repositories owned by the AWS account that called this method.
- ListRepositoriesInDomain: Returns a list of the
repositories in a domain.
- PutDomainPermissionsPolicy: Attaches a resource
policy to a domain.
- PutRepositoryPermissionsPolicy: Sets the resource
policy on a repository that specifies permissions to access it.
*
UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.
- UpdateRepository: Updates the properties of a repository.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- type AssociateExternalConnectionInput
- type AssociateExternalConnectionOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) AssociateExternalConnection(ctx context.Context, params *AssociateExternalConnectionInput, optFns ...func(*Options)) (*AssociateExternalConnectionOutput, error)
- func (c *Client) CopyPackageVersions(ctx context.Context, params *CopyPackageVersionsInput, optFns ...func(*Options)) (*CopyPackageVersionsOutput, error)
- func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error)
- func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryInput, optFns ...func(*Options)) (*CreateRepositoryOutput, error)
- func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error)
- func (c *Client) DeleteDomainPermissionsPolicy(ctx context.Context, params *DeleteDomainPermissionsPolicyInput, optFns ...func(*Options)) (*DeleteDomainPermissionsPolicyOutput, error)
- func (c *Client) DeletePackageVersions(ctx context.Context, params *DeletePackageVersionsInput, optFns ...func(*Options)) (*DeletePackageVersionsOutput, error)
- func (c *Client) DeleteRepository(ctx context.Context, params *DeleteRepositoryInput, optFns ...func(*Options)) (*DeleteRepositoryOutput, error)
- func (c *Client) DeleteRepositoryPermissionsPolicy(ctx context.Context, params *DeleteRepositoryPermissionsPolicyInput, optFns ...func(*Options)) (*DeleteRepositoryPermissionsPolicyOutput, error)
- func (c *Client) DescribeDomain(ctx context.Context, params *DescribeDomainInput, optFns ...func(*Options)) (*DescribeDomainOutput, error)
- func (c *Client) DescribePackageVersion(ctx context.Context, params *DescribePackageVersionInput, optFns ...func(*Options)) (*DescribePackageVersionOutput, error)
- func (c *Client) DescribeRepository(ctx context.Context, params *DescribeRepositoryInput, optFns ...func(*Options)) (*DescribeRepositoryOutput, error)
- func (c *Client) DisassociateExternalConnection(ctx context.Context, params *DisassociateExternalConnectionInput, optFns ...func(*Options)) (*DisassociateExternalConnectionOutput, error)
- func (c *Client) DisposePackageVersions(ctx context.Context, params *DisposePackageVersionsInput, optFns ...func(*Options)) (*DisposePackageVersionsOutput, error)
- func (c *Client) GetAuthorizationToken(ctx context.Context, params *GetAuthorizationTokenInput, optFns ...func(*Options)) (*GetAuthorizationTokenOutput, error)
- func (c *Client) GetDomainPermissionsPolicy(ctx context.Context, params *GetDomainPermissionsPolicyInput, optFns ...func(*Options)) (*GetDomainPermissionsPolicyOutput, error)
- func (c *Client) GetPackageVersionAsset(ctx context.Context, params *GetPackageVersionAssetInput, optFns ...func(*Options)) (*GetPackageVersionAssetOutput, error)
- func (c *Client) GetPackageVersionReadme(ctx context.Context, params *GetPackageVersionReadmeInput, optFns ...func(*Options)) (*GetPackageVersionReadmeOutput, error)
- func (c *Client) GetRepositoryEndpoint(ctx context.Context, params *GetRepositoryEndpointInput, optFns ...func(*Options)) (*GetRepositoryEndpointOutput, error)
- func (c *Client) GetRepositoryPermissionsPolicy(ctx context.Context, params *GetRepositoryPermissionsPolicyInput, optFns ...func(*Options)) (*GetRepositoryPermissionsPolicyOutput, error)
- func (c *Client) ListDomains(ctx context.Context, params *ListDomainsInput, optFns ...func(*Options)) (*ListDomainsOutput, error)
- func (c *Client) ListPackageVersionAssets(ctx context.Context, params *ListPackageVersionAssetsInput, optFns ...func(*Options)) (*ListPackageVersionAssetsOutput, error)
- func (c *Client) ListPackageVersionDependencies(ctx context.Context, params *ListPackageVersionDependenciesInput, optFns ...func(*Options)) (*ListPackageVersionDependenciesOutput, error)
- func (c *Client) ListPackageVersions(ctx context.Context, params *ListPackageVersionsInput, optFns ...func(*Options)) (*ListPackageVersionsOutput, error)
- func (c *Client) ListPackages(ctx context.Context, params *ListPackagesInput, optFns ...func(*Options)) (*ListPackagesOutput, error)
- func (c *Client) ListRepositories(ctx context.Context, params *ListRepositoriesInput, optFns ...func(*Options)) (*ListRepositoriesOutput, error)
- func (c *Client) ListRepositoriesInDomain(ctx context.Context, params *ListRepositoriesInDomainInput, optFns ...func(*Options)) (*ListRepositoriesInDomainOutput, error)
- func (c *Client) PutDomainPermissionsPolicy(ctx context.Context, params *PutDomainPermissionsPolicyInput, optFns ...func(*Options)) (*PutDomainPermissionsPolicyOutput, error)
- func (c *Client) PutRepositoryPermissionsPolicy(ctx context.Context, params *PutRepositoryPermissionsPolicyInput, optFns ...func(*Options)) (*PutRepositoryPermissionsPolicyOutput, error)
- func (c *Client) UpdatePackageVersionsStatus(ctx context.Context, params *UpdatePackageVersionsStatusInput, optFns ...func(*Options)) (*UpdatePackageVersionsStatusOutput, error)
- func (c *Client) UpdateRepository(ctx context.Context, params *UpdateRepositoryInput, optFns ...func(*Options)) (*UpdateRepositoryOutput, error)
- type CopyPackageVersionsInput
- type CopyPackageVersionsOutput
- type CreateDomainInput
- type CreateDomainOutput
- type CreateRepositoryInput
- type CreateRepositoryOutput
- type DeleteDomainInput
- type DeleteDomainOutput
- type DeleteDomainPermissionsPolicyInput
- type DeleteDomainPermissionsPolicyOutput
- type DeletePackageVersionsInput
- type DeletePackageVersionsOutput
- type DeleteRepositoryInput
- type DeleteRepositoryOutput
- type DeleteRepositoryPermissionsPolicyInput
- type DeleteRepositoryPermissionsPolicyOutput
- type DescribeDomainInput
- type DescribeDomainOutput
- type DescribePackageVersionInput
- type DescribePackageVersionOutput
- type DescribeRepositoryInput
- type DescribeRepositoryOutput
- type DisassociateExternalConnectionInput
- type DisassociateExternalConnectionOutput
- type DisposePackageVersionsInput
- type DisposePackageVersionsOutput
- type EndpointResolver
- type EndpointResolverFunc
- type GetAuthorizationTokenInput
- type GetAuthorizationTokenOutput
- type GetDomainPermissionsPolicyInput
- type GetDomainPermissionsPolicyOutput
- type GetPackageVersionAssetInput
- type GetPackageVersionAssetOutput
- type GetPackageVersionReadmeInput
- type GetPackageVersionReadmeOutput
- type GetRepositoryEndpointInput
- type GetRepositoryEndpointOutput
- type GetRepositoryPermissionsPolicyInput
- type GetRepositoryPermissionsPolicyOutput
- type HTTPClient
- type HTTPSignerV4
- type ListDomainsInput
- type ListDomainsOutput
- type ListPackageVersionAssetsInput
- type ListPackageVersionAssetsOutput
- type ListPackageVersionDependenciesInput
- type ListPackageVersionDependenciesOutput
- type ListPackageVersionsInput
- type ListPackageVersionsOutput
- type ListPackagesInput
- type ListPackagesOutput
- type ListRepositoriesInDomainInput
- type ListRepositoriesInDomainOutput
- type ListRepositoriesInput
- type ListRepositoriesOutput
- type Options
- type PutDomainPermissionsPolicyInput
- type PutDomainPermissionsPolicyOutput
- type PutRepositoryPermissionsPolicyInput
- type PutRepositoryPermissionsPolicyOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolverOptions
- type UpdatePackageVersionsStatusInput
- type UpdatePackageVersionsStatusOutput
- type UpdateRepositoryInput
- type UpdateRepositoryOutput
Constants ¶
const ServiceAPIVersion = "2018-09-22"
const ServiceID = "codeartifact"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
Types ¶
type AssociateExternalConnectionInput ¶
type AssociateExternalConnectionInput struct { // The name of the domain that contains the repository. // // This member is required. Domain *string // The name of the external connection to add to the repository. The following // values are supported: // // * public:npmjs - for the npm public repository. // // // * public:pypi - for the Python Package Index. // // * public:maven-central - for // Maven Central. // // * public:maven-googleandroid - for the Google Android // repository. // // * public:maven-gradleplugins - for the Gradle plugins // repository. // // * public:maven-commonsware - for the CommonsWare Android // repository. // // This member is required. ExternalConnection *string // The name of the repository to which the external connection is added. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string }
type AssociateExternalConnectionOutput ¶
type AssociateExternalConnectionOutput struct { // Information about the connected repository after processing the request. Repository *types.RepositoryDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for CodeArtifact.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AssociateExternalConnection ¶
func (c *Client) AssociateExternalConnection(ctx context.Context, params *AssociateExternalConnectionInput, optFns ...func(*Options)) (*AssociateExternalConnectionOutput, error)
Adds an existing external connection to a repository. One external connection is allowed per repository. A repository can have one or more upstream repositories, or an external connection.
func (*Client) CopyPackageVersions ¶
func (c *Client) CopyPackageVersions(ctx context.Context, params *CopyPackageVersionsInput, optFns ...func(*Options)) (*CopyPackageVersionsOutput, error)
Copies package versions from one repository to another repository in the same domain. You must specify versions or versionRevisions. You cannot specify both.
func (*Client) CreateDomain ¶
func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error)
Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different AWS accounts. An asset is stored only once in a domain, even if it's in multiple repositories. Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.
func (*Client) CreateRepository ¶
func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryInput, optFns ...func(*Options)) (*CreateRepositoryOutput, error)
Creates a repository.
func (*Client) DeleteDomain ¶
func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error)
Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.
func (*Client) DeleteDomainPermissionsPolicy ¶
func (c *Client) DeleteDomainPermissionsPolicy(ctx context.Context, params *DeleteDomainPermissionsPolicyInput, optFns ...func(*Options)) (*DeleteDomainPermissionsPolicyOutput, error)
Deletes the resource policy set on a domain.
func (*Client) DeletePackageVersions ¶
func (c *Client) DeletePackageVersions(ctx context.Context, params *DeletePackageVersionsInput, optFns ...func(*Options)) (*DeletePackageVersionsOutput, error)
Deletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to Archived. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, ListackageVersions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html)), but you can restore them using UpdatePackageVersionsStatus (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html).
func (*Client) DeleteRepository ¶
func (c *Client) DeleteRepository(ctx context.Context, params *DeleteRepositoryInput, optFns ...func(*Options)) (*DeleteRepositoryOutput, error)
Deletes a repository.
func (*Client) DeleteRepositoryPermissionsPolicy ¶
func (c *Client) DeleteRepositoryPermissionsPolicy(ctx context.Context, params *DeleteRepositoryPermissionsPolicyInput, optFns ...func(*Options)) (*DeleteRepositoryPermissionsPolicyOutput, error)
Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate. Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, AWS users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.
func (*Client) DescribeDomain ¶
func (c *Client) DescribeDomain(ctx context.Context, params *DescribeDomainInput, optFns ...func(*Options)) (*DescribeDomainOutput, error)
Returns a DomainDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainDescription.html) object that contains information about the requested domain.
func (*Client) DescribePackageVersion ¶
func (c *Client) DescribePackageVersion(ctx context.Context, params *DescribePackageVersionInput, optFns ...func(*Options)) (*DescribePackageVersionOutput, error)
Returns a PackageVersionDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) object that contains information about the requested package version.
func (*Client) DescribeRepository ¶
func (c *Client) DescribeRepository(ctx context.Context, params *DescribeRepositoryInput, optFns ...func(*Options)) (*DescribeRepositoryOutput, error)
Returns a RepositoryDescription object that contains detailed information about the requested repository.
func (*Client) DisassociateExternalConnection ¶
func (c *Client) DisassociateExternalConnection(ctx context.Context, params *DisassociateExternalConnectionInput, optFns ...func(*Options)) (*DisassociateExternalConnectionOutput, error)
Removes an existing external connection from a repository.
func (*Client) DisposePackageVersions ¶
func (c *Client) DisposePackageVersions(ctx context.Context, params *DisposePackageVersionsInput, optFns ...func(*Options)) (*DisposePackageVersionsOutput, error)
Deletes the assets in package versions and sets the package versions' status to Disposed. A disposed package version cannot be restored in your repository because its assets are deleted. To view all disposed package versions in a repository, use ListackageVersions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html) and set the status (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html#API_ListPackageVersions_RequestSyntax) parameter to Disposed. To view information about a disposed package version, use ListPackageVersions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html) and set the status (https://docs.aws.amazon.com/API_ListPackageVersions.html#codeartifact-ListPackageVersions-response-status) parameter to Disposed.
func (*Client) GetAuthorizationToken ¶
func (c *Client) GetAuthorizationToken(ctx context.Context, params *GetAuthorizationTokenInput, optFns ...func(*Options)) (*GetAuthorizationTokenOutput, error)
Generates a temporary authentication token for accessing repositories in the domain. This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. You can call login periodically to refresh the token. When you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds parameter. The authorization period begins after login or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration. See Using IAM Roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) for more information on controlling session duration.
func (*Client) GetDomainPermissionsPolicy ¶
func (c *Client) GetDomainPermissionsPolicy(ctx context.Context, params *GetDomainPermissionsPolicyInput, optFns ...func(*Options)) (*GetDomainPermissionsPolicyOutput, error)
Returns the resource policy attached to the specified domain. The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) in the AWS Identity and Access Management User Guide.
func (*Client) GetPackageVersionAsset ¶
func (c *Client) GetPackageVersionAsset(ctx context.Context, params *GetPackageVersionAssetInput, optFns ...func(*Options)) (*GetPackageVersionAssetOutput, error)
Returns an asset (or file) that is in a package. For example, for a Maven package version, use GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version.
func (*Client) GetPackageVersionReadme ¶
func (c *Client) GetPackageVersionReadme(ctx context.Context, params *GetPackageVersionReadmeInput, optFns ...func(*Options)) (*GetPackageVersionReadmeOutput, error)
Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact extracts a description from a metadata file. For example, from the element in the pom.xml file of a Maven package. The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.
func (*Client) GetRepositoryEndpoint ¶
func (c *Client) GetRepositoryEndpoint(ctx context.Context, params *GetRepositoryEndpointInput, optFns ...func(*Options)) (*GetRepositoryEndpointOutput, error)
Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
npm
pypi
maven
func (*Client) GetRepositoryPermissionsPolicy ¶
func (c *Client) GetRepositoryPermissionsPolicy(ctx context.Context, params *GetRepositoryPermissionsPolicyInput, optFns ...func(*Options)) (*GetRepositoryPermissionsPolicyOutput, error)
Returns the resource policy that is set on a repository.
func (*Client) ListDomains ¶
func (c *Client) ListDomains(ctx context.Context, params *ListDomainsInput, optFns ...func(*Options)) (*ListDomainsOutput, error)
Returns a list of DomainSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) objects for all domains owned by the AWS account that makes this call. Each returned DomainSummary object contains information about a domain.
func (*Client) ListPackageVersionAssets ¶
func (c *Client) ListPackageVersionAssets(ctx context.Context, params *ListPackageVersionAssetsInput, optFns ...func(*Options)) (*ListPackageVersionAssetsOutput, error)
Returns a list of AssetSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html) objects for assets in a package version.
func (*Client) ListPackageVersionDependencies ¶
func (c *Client) ListPackageVersionDependencies(ctx context.Context, params *ListPackageVersionDependenciesInput, optFns ...func(*Options)) (*ListPackageVersionDependenciesOutput, error)
Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html) objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the package.json file for npm packages and the pom.xml file for Maven). Any package version dependencies that are not listed in the configuration file are not returned.
func (*Client) ListPackageVersions ¶
func (c *Client) ListPackageVersions(ctx context.Context, params *ListPackageVersionsInput, optFns ...func(*Options)) (*ListPackageVersionsOutput, error)
Returns a list of PackageVersionSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html) objects for package versions in a repository that match the request parameters.
func (*Client) ListPackages ¶
func (c *Client) ListPackages(ctx context.Context, params *ListPackagesInput, optFns ...func(*Options)) (*ListPackagesOutput, error)
Returns a list of PackageSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html) objects for packages in a repository that match the request parameters.
func (*Client) ListRepositories ¶
func (c *Client) ListRepositories(ctx context.Context, params *ListRepositoriesInput, optFns ...func(*Options)) (*ListRepositoriesOutput, error)
Returns a list of RepositorySummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html) objects. Each RepositorySummary contains information about a repository in the specified AWS account and that matches the input parameters.
func (*Client) ListRepositoriesInDomain ¶
func (c *Client) ListRepositoriesInDomain(ctx context.Context, params *ListRepositoriesInDomainInput, optFns ...func(*Options)) (*ListRepositoriesInDomainOutput, error)
Returns a list of RepositorySummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html) objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters.
func (*Client) PutDomainPermissionsPolicy ¶
func (c *Client) PutDomainPermissionsPolicy(ctx context.Context, params *PutDomainPermissionsPolicyInput, optFns ...func(*Options)) (*PutDomainPermissionsPolicyOutput, error)
Sets a resource policy on a domain that specifies permissions to access it.
func (*Client) PutRepositoryPermissionsPolicy ¶
func (c *Client) PutRepositoryPermissionsPolicy(ctx context.Context, params *PutRepositoryPermissionsPolicyInput, optFns ...func(*Options)) (*PutRepositoryPermissionsPolicyOutput, error)
Sets the resource policy on a repository that specifies permissions to access it.
func (*Client) UpdatePackageVersionsStatus ¶
func (c *Client) UpdatePackageVersionsStatus(ctx context.Context, params *UpdatePackageVersionsStatusInput, optFns ...func(*Options)) (*UpdatePackageVersionsStatusOutput, error)
Updates the status of one or more versions of a package.
func (*Client) UpdateRepository ¶
func (c *Client) UpdateRepository(ctx context.Context, params *UpdateRepositoryInput, optFns ...func(*Options)) (*UpdateRepositoryOutput, error)
Update the properties of a repository.
type CopyPackageVersionsInput ¶
type CopyPackageVersionsInput struct { // The name of the repository into which package versions are copied. // // This member is required. DestinationRepository *string // The name of the domain that contains the source and destination repositories. // // This member is required. Domain *string // The format of the package that is copied. The valid package types are: // // * // npm: A Node Package Manager (npm) package. // // * pypi: A Python Package Index // (PyPI) package. // // * maven: A Maven package that contains compiled code in a // distributable format, such as a JAR file. // // This member is required. Format types.PackageFormat // The name of the package that is copied. // // This member is required. Package *string // The name of the repository that contains the package versions to copy. // // This member is required. SourceRepository *string // Set to true to overwrite a package version that already exists in the // destination repository. If set to false and the package version already exists // in the destination repository, the package version is returned in the // failedVersions field of the response with an ALREADY_EXISTS error code. AllowOverwrite *bool // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // Set to true to copy packages from repositories that are upstream from the source // repository to the destination repository. The default setting is false. For more // information, see Working with upstream repositories // (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html). IncludeFromUpstream *bool // 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. Namespace *string // A list of key-value pairs. The keys are package versions and the values are // package version revisions. A CopyPackageVersion operation succeeds if the // specified versions in the source repository match the specified package version // revision. You must specify versions or versionRevisions. You cannot specify // both. VersionRevisions map[string]*string // The versions of the package to copy. You must specify versions or // versionRevisions. You cannot specify both. Versions []*string }
type CopyPackageVersionsOutput ¶
type CopyPackageVersionsOutput struct { // A map of package versions that failed to copy and their error codes. The // possible error codes are in the PackageVersionError data type. They are: // // * // ALREADY_EXISTS // // * MISMATCHED_REVISION // // * MISMATCHED_STATUS // // * // NOT_ALLOWED // // * NOT_FOUND // // * SKIPPED FailedVersions map[string]*types.PackageVersionError // A list of the package versions that were successfully copied to your repository. SuccessfulVersions map[string]*types.SuccessfulPackageVersionInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateDomainInput ¶
type CreateDomainInput struct { // The name of the domain to create. All domain names in an AWS Region that are in // the same AWS account must be unique. The domain name is used as the prefix in // DNS hostnames. Do not use sensitive information in a domain name because it is // publicly discoverable. // // This member is required. Domain *string // The encryption key for the domain. This is used to encrypt content stored in a // domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a // key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must // have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that // is used. For more information, see DescribeKey // (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax) // in the AWS Key Management Service API Reference and AWS KMS API Permissions // Reference // (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // in the AWS Key Management Service Developer Guide. CodeArtifact supports only // symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more // information, see Using symmetric and asymmetric keys // (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) // in the AWS Key Management Service Developer Guide. EncryptionKey *string }
type CreateDomainOutput ¶
type CreateDomainOutput struct { // Contains information about the created domain after processing the request. Domain *types.DomainDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateRepositoryInput ¶
type CreateRepositoryInput struct { // The domain that contains the created repository. // // This member is required. Domain *string // The name of the repository to create. // // This member is required. Repository *string // A description of the created repository. Description *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // A list of upstream repositories to associate with the repository. The order of // the upstream repositories in the list determines their priority order when AWS // CodeArtifact looks for a requested package version. For more information, see // Working with upstream repositories // (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html). Upstreams []*types.UpstreamRepository }
type CreateRepositoryOutput ¶
type CreateRepositoryOutput struct { // Information about the created repository after processing the request. Repository *types.RepositoryDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteDomainInput ¶
type DeleteDomainInput struct { // The name of the domain to delete. // // This member is required. Domain *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string }
type DeleteDomainOutput ¶
type DeleteDomainOutput struct { // Contains information about the deleted domain after processing the request. Domain *types.DomainDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteDomainPermissionsPolicyInput ¶
type DeleteDomainPermissionsPolicyInput struct { // The name of the domain associated with the resource policy to be deleted. // // This member is required. Domain *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // The current revision of the resource policy to be deleted. This revision is used // for optimistic locking, which prevents others from overwriting your changes to // the domain's resource policy. PolicyRevision *string }
type DeleteDomainPermissionsPolicyOutput ¶
type DeleteDomainPermissionsPolicyOutput struct { // Information about the deleted resource policy after processing the request. Policy *types.ResourcePolicy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeletePackageVersionsInput ¶
type DeletePackageVersionsInput struct { // The name of the domain that contains the package to delete. // // This member is required. Domain *string // The format of the package versions to delete. The valid values are: // // * npm // // // * pypi // // * maven // // This member is required. Format types.PackageFormat // The name of the package with the versions to delete. // // This member is required. Package *string // The name of the repository that contains the package versions to delete. // // This member is required. Repository *string // An array of strings that specify the versions of the package to delete. // // This member is required. Versions []*string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // The expected status of the package version to delete. Valid values are: // // * // Published // // * Unfinished // // * Unlisted // // * Archived // // * Disposed ExpectedStatus types.PackageVersionStatus // 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. Namespace *string }
type DeletePackageVersionsOutput ¶
type DeletePackageVersionsOutput struct { // A PackageVersionError object that contains a map of errors codes for the deleted // package that failed. The possible error codes are: // // * ALREADY_EXISTS // // * // MISMATCHED_REVISION // // * MISMATCHED_STATUS // // * NOT_ALLOWED // // * // NOT_FOUND // // * SKIPPED FailedVersions map[string]*types.PackageVersionError // A list of the package versions that were successfully deleted. SuccessfulVersions map[string]*types.SuccessfulPackageVersionInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteRepositoryInput ¶
type DeleteRepositoryInput struct { // The name of the domain that contains the repository to delete. // // This member is required. Domain *string // The name of the repository to delete. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string }
type DeleteRepositoryOutput ¶
type DeleteRepositoryOutput struct { // Information about the deleted repository after processing the request. Repository *types.RepositoryDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteRepositoryPermissionsPolicyInput ¶
type DeleteRepositoryPermissionsPolicyInput struct { // The name of the domain that contains the repository associated with the resource // policy to be deleted. // // This member is required. Domain *string // The name of the repository that is associated with the resource policy to be // deleted // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // The revision of the repository's resource policy to be deleted. This revision is // used for optimistic locking, which prevents others from accidentally overwriting // your changes to the repository's resource policy. PolicyRevision *string }
type DeleteRepositoryPermissionsPolicyOutput ¶
type DeleteRepositoryPermissionsPolicyOutput struct { // Information about the deleted policy after processing the request. Policy *types.ResourcePolicy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeDomainInput ¶
type DescribeDomainInput struct { // A string that specifies the name of the requested domain. // // This member is required. Domain *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string }
type DescribeDomainOutput ¶
type DescribeDomainOutput struct { // Information about a domain. A domain is a container for repositories. When you // create a domain, it is empty until you add one or more repositories. Domain *types.DomainDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribePackageVersionInput ¶
type DescribePackageVersionInput struct { // The name of the domain that contains the repository that contains the package // version. // // This member is required. Domain *string // A format that specifies the type of the requested package version. The valid // values are: // // * npm // // * pypi // // * maven // // This member is required. Format types.PackageFormat // The name of the requested package version. // // This member is required. Package *string // A string that contains the package version (for example, 3.5.2). // // This member is required. PackageVersion *string // The name of the repository that contains the package version. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *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. Namespace *string }
type DescribePackageVersionOutput ¶
type DescribePackageVersionOutput struct { // A PackageVersionDescription // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) // object that contains information about the requested package version. // // This member is required. PackageVersion *types.PackageVersionDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeRepositoryInput ¶
type DescribeRepositoryInput struct { // The name of the domain that contains the repository to describe. // // This member is required. Domain *string // A string that specifies the name of the requested repository. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string }
type DescribeRepositoryOutput ¶
type DescribeRepositoryOutput struct { // A RepositoryDescription object that contains the requested repository // information. Repository *types.RepositoryDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DisassociateExternalConnectionInput ¶
type DisassociateExternalConnectionInput struct { // The name of the domain that contains the repository from which to remove the // external repository. // // This member is required. Domain *string // The name of the external connection to be removed from the repository. // // This member is required. ExternalConnection *string // The name of the repository from which the external connection will be removed. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string }
type DisassociateExternalConnectionOutput ¶
type DisassociateExternalConnectionOutput struct { // The repository associated with the removed external connection. Repository *types.RepositoryDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DisposePackageVersionsInput ¶
type DisposePackageVersionsInput struct { // The name of the domain that contains the repository you want to dispose. // // This member is required. Domain *string // A format that specifies the type of package versions you want to dispose. The // valid values are: // // * npm // // * pypi // // * maven // // This member is required. Format types.PackageFormat // The name of the package with the versions you want to dispose. // // This member is required. Package *string // The name of the repository that contains the package versions you want to // dispose. // // This member is required. Repository *string // The versions of the package you want to dispose. // // This member is required. Versions []*string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // The expected status of the package version to dispose. Valid values are: // // * // Published // // * Unfinished // // * Unlisted // // * Archived // // * Disposed ExpectedStatus types.PackageVersionStatus // 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. Namespace *string // The revisions of the package versions you want to dispose. VersionRevisions map[string]*string }
type DisposePackageVersionsOutput ¶
type DisposePackageVersionsOutput struct { // A PackageVersionError object that contains a map of errors codes for the // disposed package versions that failed. The possible error codes are: // // * // ALREADY_EXISTS // // * MISMATCHED_REVISION // // * MISMATCHED_STATUS // // * // NOT_ALLOWED // // * NOT_FOUND // // * SKIPPED FailedVersions map[string]*types.PackageVersionError // A list of the package versions that were successfully disposed. SuccessfulVersions map[string]*types.SuccessfulPackageVersionInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)
type GetAuthorizationTokenInput ¶
type GetAuthorizationTokenInput struct { // The name of the domain that is in scope for the generated authorization token. // // This member is required. Domain *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // The time, in seconds, that the generated authorization token is valid. DurationSeconds *int64 }
type GetAuthorizationTokenOutput ¶
type GetAuthorizationTokenOutput struct { // The returned authentication token. AuthorizationToken *string // A timestamp that specifies the date and time the authorization token expires. Expiration *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetDomainPermissionsPolicyInput ¶
type GetDomainPermissionsPolicyInput struct { // The name of the domain to which the resource policy is attached. // // This member is required. Domain *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string }
type GetDomainPermissionsPolicyOutput ¶
type GetDomainPermissionsPolicyOutput struct { // The returned resource policy. Policy *types.ResourcePolicy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetPackageVersionAssetInput ¶
type GetPackageVersionAssetInput struct { // The name of the requested asset. // // This member is required. Asset *string // The domain that contains the repository that contains the package version with // the requested asset. // // This member is required. Domain *string // A format that specifies the type of the package version with the requested asset // file. The valid values are: // // * npm // // * pypi // // * maven // // This member is required. Format types.PackageFormat // The name of the package that contains the requested asset. // // This member is required. Package *string // A string that contains the package version (for example, 3.5.2). // // This member is required. PackageVersion *string // The repository that contains the package version with the requested asset. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *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. Namespace *string // The name of the package version revision that contains the requested asset. PackageVersionRevision *string }
type GetPackageVersionAssetOutput ¶
type GetPackageVersionAssetOutput struct { // The binary file, or asset, that is downloaded. Asset io.ReadCloser // The name of the asset that is downloaded. AssetName *string // A string that contains the package version (for example, 3.5.2). PackageVersion *string // The name of the package version revision that contains the downloaded asset. PackageVersionRevision *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetPackageVersionReadmeInput ¶
type GetPackageVersionReadmeInput struct { // The name of the domain that contains the repository that contains the package // version with the requested readme file. // // This member is required. Domain *string // A format that specifies the type of the package version with the requested // readme file. The valid values are: // // * npm // // * pypi // // * maven // // This member is required. Format types.PackageFormat // The name of the package version that contains the requested readme file. // // This member is required. Package *string // A string that contains the package version (for example, 3.5.2). // // This member is required. PackageVersion *string // The repository that contains the package with the requested readme file. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *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. Namespace *string }
type GetPackageVersionReadmeOutput ¶
type GetPackageVersionReadmeOutput struct { // The format of the package with the requested readme file. Valid format types // are: // // * npm // // * pypi // // * maven Format types.PackageFormat // 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. Namespace *string // The name of the package that contains the returned readme file. Package *string // The text of the returned readme file. Readme *string // The version of the package with the requested readme file. Version *string // The current revision associated with the package version. VersionRevision *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetRepositoryEndpointInput ¶
type GetRepositoryEndpointInput struct { // The name of the domain that contains the repository. // // This member is required. Domain *string // Returns which endpoint of a repository to return. A repository has one endpoint // for each package format: // // * npm // // * pypi // // * maven // // This member is required. Format types.PackageFormat // The name of the repository. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain that // contains the repository. It does not include dashes or spaces. DomainOwner *string }
type GetRepositoryEndpointOutput ¶
type GetRepositoryEndpointOutput struct { // A string that specifies the URL of the returned endpoint. RepositoryEndpoint *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetRepositoryPermissionsPolicyInput ¶
type GetRepositoryPermissionsPolicyInput struct { // The name of the domain containing the repository whose associated resource // policy is to be retrieved. // // This member is required. Domain *string // The name of the repository whose associated resource policy is to be retrieved. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string }
type GetRepositoryPermissionsPolicyOutput ¶
type GetRepositoryPermissionsPolicyOutput struct { // The returned resource policy. Policy *types.ResourcePolicy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type ListDomainsInput ¶
type ListDomainsInput struct { // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string }
type ListDomainsOutput ¶
type ListDomainsOutput struct { // The returned list of DomainSummary // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainSummary.html) // objects. Domains []*types.DomainSummary // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListPackageVersionAssetsInput ¶
type ListPackageVersionAssetsInput struct { // The name of the domain that contains the repository associated with the package // version assets. // // This member is required. Domain *string // The format of the package that contains the returned package version assets. The // valid package types are: // // * npm: A Node Package Manager (npm) package. // // // * pypi: A Python Package Index (PyPI) package. // // * maven: A Maven package // that contains compiled code in a distributable format, such as a JAR file. // // This member is required. Format types.PackageFormat // The name of the package that contains the returned package version assets. // // This member is required. Package *string // A string that contains the package version (for example, 3.5.2). // // This member is required. PackageVersion *string // The name of the repository that contains the package that contains the returned // package version assets. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // The maximum number of results to return per page. MaxResults *int32 // 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. Namespace *string // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string }
type ListPackageVersionAssetsOutput ¶
type ListPackageVersionAssetsOutput struct { // The returned list of AssetSummary // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html) // objects. Assets []*types.AssetSummary // The format of the package that contains the returned package version assets. Format types.PackageFormat // 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. Namespace *string // If there are additional results, this is the token for the next set of results. NextToken *string // The name of the package that contains the returned package version assets. Package *string // The version of the package associated with the returned assets. Version *string // The current revision associated with the package version. VersionRevision *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListPackageVersionDependenciesInput ¶
type ListPackageVersionDependenciesInput struct { // The domain that contains the repository that contains the requested package // version dependencies. // // This member is required. Domain *string // The format of the package with the requested dependencies. The valid package // types are: // // * npm: A Node Package Manager (npm) package. // // * pypi: A // Python Package Index (PyPI) package. // // * maven: A Maven package that contains // compiled code in a distributable format, such as a JAR file. // // This member is required. Format types.PackageFormat // The name of the package versions' package. // // This member is required. Package *string // A string that contains the package version (for example, 3.5.2). // // This member is required. PackageVersion *string // The name of the repository that contains the requested package version. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *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. Namespace *string // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string }
type ListPackageVersionDependenciesOutput ¶
type ListPackageVersionDependenciesOutput struct { // The returned list of PackageDependency // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html) // objects. Dependencies []*types.PackageDependency // A format that specifies the type of the package that contains the returned // dependencies. The valid values are: // // * npm // // * pypi // // * maven Format types.PackageFormat // 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. Namespace *string // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // The name of the package that contains the returned package versions // dependencies. Package *string // The version of the package that is specified in the request. Version *string // The current revision associated with the package version. VersionRevision *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListPackageVersionsInput ¶
type ListPackageVersionsInput struct { // The name of the domain that contains the repository that contains the returned // package versions. // // This member is required. Domain *string // The format of the returned packages. The valid package types are: // // * npm: A // Node Package Manager (npm) package. // // * pypi: A Python Package Index (PyPI) // package. // // * maven: A Maven package that contains compiled code in a // distributable format, such as a JAR file. // // This member is required. Format types.PackageFormat // The name of the package for which you want to return a list of package versions. // // This member is required. Package *string // The name of the repository that contains the package. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // The maximum number of results to return per page. MaxResults *int32 // 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. Namespace *string // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // How to sort the returned list of package versions. SortBy types.PackageVersionSortType // A string that specifies the status of the package versions to include in the // returned list. It can be one of the following: // // * Published // // * // Unfinished // // * Unlisted // // * Archived // // * Disposed Status types.PackageVersionStatus }
type ListPackageVersionsOutput ¶
type ListPackageVersionsOutput struct { // The default package version to display. This depends on the package format: // // // * For Maven and PyPI packages, it's the most recently published package // version. // // * For npm packages, it's the version referenced by the latest tag. // If the latest tag is not set, it's the most recently published package version. DefaultDisplayVersion *string // A format of the package. Valid package format values are: // // * npm // // * // pypi // // * maven Format types.PackageFormat // 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. Namespace *string // If there are additional results, this is the token for the next set of results. NextToken *string // The name of the package. Package *string // The returned list of PackageVersionSummary // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html) // objects. Versions []*types.PackageVersionSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListPackagesInput ¶
type ListPackagesInput struct { // The domain that contains the repository that contains the requested list of // packages. // // This member is required. Domain *string // The name of the repository from which packages are to be listed. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // The format of the packages. The valid package types are: // // * npm: A Node // Package Manager (npm) package. // // * pypi: A Python Package Index (PyPI) // package. // // * maven: A Maven package that contains compiled code in a // distributable format, such as a JAR file. Format types.PackageFormat // The maximum number of results to return per page. MaxResults *int32 // 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. Namespace *string // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // A prefix used to filter returned repositories. Only repositories with names that // start with repositoryPrefix are returned. PackagePrefix *string }
type ListPackagesOutput ¶
type ListPackagesOutput struct { // If there are additional results, this is the token for the next set of results. NextToken *string // The list of returned PackageSummary // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html) // objects. Packages []*types.PackageSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListRepositoriesInDomainInput ¶
type ListRepositoriesInDomainInput struct { // The name of the domain that contains the returned list of repositories. // // This member is required. Domain *string // Filter the list of repositories to only include those that are managed by the // AWS account ID. AdministratorAccount *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // A prefix used to filter returned repositories. Only repositories with names that // start with repositoryPrefix are returned. RepositoryPrefix *string }
type ListRepositoriesInDomainOutput ¶
type ListRepositoriesInDomainOutput struct { // If there are additional results, this is the token for the next set of results. NextToken *string // The returned list of repositories. Repositories []*types.RepositorySummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListRepositoriesInput ¶
type ListRepositoriesInput struct { // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // A prefix used to filter returned repositories. Only repositories with names that // start with repositoryPrefix are returned. RepositoryPrefix *string }
type ListRepositoriesOutput ¶
type ListRepositoriesOutput struct { // If there are additional results, this is the token for the next set of results. NextToken *string // The returned list of RepositorySummary // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html) // objects. Repositories []*types.RepositorySummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type PutDomainPermissionsPolicyInput ¶
type PutDomainPermissionsPolicyInput struct { // The name of the domain on which to set the resource policy. // // This member is required. Domain *string // A valid displayable JSON Aspen policy string to be set as the access control // resource policy on the provided domain. // // This member is required. PolicyDocument *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // The current revision of the resource policy to be set. This revision is used for // optimistic locking, which prevents others from overwriting your changes to the // domain's resource policy. PolicyRevision *string }
type PutDomainPermissionsPolicyOutput ¶
type PutDomainPermissionsPolicyOutput struct { // The resource policy that was set after processing the request. Policy *types.ResourcePolicy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type PutRepositoryPermissionsPolicyInput ¶
type PutRepositoryPermissionsPolicyInput struct { // The name of the domain containing the repository to set the resource policy on. // // This member is required. Domain *string // A valid displayable JSON Aspen policy string to be set as the access control // resource policy on the provided repository. // // This member is required. PolicyDocument *string // The name of the repository to set the resource policy on. // // This member is required. Repository *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // Sets the revision of the resource policy that specifies permissions to access // the repository. This revision is used for optimistic locking, which prevents // others from overwriting your changes to the repository's resource policy. PolicyRevision *string }
type PutRepositoryPermissionsPolicyOutput ¶
type PutRepositoryPermissionsPolicyOutput struct { // The resource policy that was set after processing the request. Policy *types.ResourcePolicy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type UpdatePackageVersionsStatusInput ¶
type UpdatePackageVersionsStatusInput struct { // The domain that contains the repository that contains the package versions with // a status to be updated. // // This member is required. Domain *string // A format that specifies the type of the package with the statuses to update. The // valid values are: // // * npm // // * pypi // // * maven // // This member is required. Format types.PackageFormat // The name of the package with the version statuses to update. // // This member is required. Package *string // The repository that contains the package versions with the status you want to // update. // // This member is required. Repository *string // The status you want to change the package version status to. // // This member is required. TargetStatus types.PackageVersionStatus // An array of strings that specify the versions of the package with the statuses // to update. // // This member is required. Versions []*string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // The package version’s expected status before it is updated. If expectedStatus is // provided, the package version's status is updated only if its status at the time // UpdatePackageVersionsStatus is called matches expectedStatus. ExpectedStatus types.PackageVersionStatus // 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. Namespace *string // A map of package versions and package version revisions. The map key is the // package version (for example, 3.5.2), and the map value is the package version // revision. VersionRevisions map[string]*string }
type UpdatePackageVersionsStatusOutput ¶
type UpdatePackageVersionsStatusOutput struct { // A list of SuccessfulPackageVersionInfo objects, one for each package version // with a status that successfully updated. FailedVersions map[string]*types.PackageVersionError // A list of PackageVersionError objects, one for each package version with a // status that failed to update. SuccessfulVersions map[string]*types.SuccessfulPackageVersionInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateRepositoryInput ¶
type UpdateRepositoryInput struct { // The name of the domain associated with the repository to update. // // This member is required. Domain *string // The name of the repository to update. // // This member is required. Repository *string // An updated repository description. Description *string // The 12-digit account number of the AWS account that owns the domain. It does not // include dashes or spaces. DomainOwner *string // A list of upstream repositories to associate with the repository. The order of // the upstream repositories in the list determines their priority order when AWS // CodeArtifact looks for a requested package version. For more information, see // Working with upstream repositories // (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html). Upstreams []*types.UpstreamRepository }
type UpdateRepositoryOutput ¶
type UpdateRepositoryOutput struct { // The updated repository. Repository *types.RepositoryDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_AssociateExternalConnection.go api_op_CopyPackageVersions.go api_op_CreateDomain.go api_op_CreateRepository.go api_op_DeleteDomain.go api_op_DeleteDomainPermissionsPolicy.go api_op_DeletePackageVersions.go api_op_DeleteRepository.go api_op_DeleteRepositoryPermissionsPolicy.go api_op_DescribeDomain.go api_op_DescribePackageVersion.go api_op_DescribeRepository.go api_op_DisassociateExternalConnection.go api_op_DisposePackageVersions.go api_op_GetAuthorizationToken.go api_op_GetDomainPermissionsPolicy.go api_op_GetPackageVersionAsset.go api_op_GetPackageVersionReadme.go api_op_GetRepositoryEndpoint.go api_op_GetRepositoryPermissionsPolicy.go api_op_ListDomains.go api_op_ListPackageVersionAssets.go api_op_ListPackageVersionDependencies.go api_op_ListPackageVersions.go api_op_ListPackages.go api_op_ListRepositories.go api_op_ListRepositoriesInDomain.go api_op_PutDomainPermissionsPolicy.go api_op_PutRepositoryPermissionsPolicy.go api_op_UpdatePackageVersionsStatus.go api_op_UpdateRepository.go deserializers.go doc.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.28.0
- Published
- Oct 26, 2020
- Platform
- darwin/amd64
- Imports
- 27 packages
- Last checked
- now –
Tools for package owners.