codeartifact

package module
v1.26.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 39 Imported by: 17

Documentation

Overview

Package codeartifact provides the API client, operations, and parameter types for CodeArtifact.

CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. 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. CodeArtifact concepts

  • 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 ), Python CLIs ( pip and twine ), NuGet CLIs ( nuget and dotnet ), and the Swift package manager ( swift ).
  • 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 Key Management Service (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) , Maven (https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven) , NuGet (https://docs.aws.amazon.com/codeartifact/latest/ug/using-nuget) , Swift (https://docs.aws.amazon.com/codeartifact/latest/ug/using-swift) , and generic (https://docs.aws.amazon.com/codeartifact/latest/ug/using-generic) 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 group: A group of packages that match a specified definition. Package groups can be used to apply configuration to multiple packages that match a defined pattern using package format, package namespace, and package name. You can use package groups to more conveniently configure package origin controls for multiple packages. Package origin controls are used to block or allow ingestion or publishing of new package versions, which protects users from malicious actions known as dependency substitution attacks.
  • 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 supported API 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.
  • CreatePackageGroup : Creates a package group.
  • 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.
  • DeletePackage : Deletes a package and all associated package versions.
  • DeletePackageGroup : Deletes a package group. Does not delete packages or package versions that are associated with a package group.
  • 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.
  • DescribePackage : Returns a PackageDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html) object that contains details about a package.
  • DescribePackageGroup : Returns a PackageGroup (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageGroup.html) object that contains details about a package group.
  • 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.
  • GetAssociatedPackageGroup : Returns the most closely associated package group to the specified package.
  • 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:
  • generic
  • maven
  • npm
  • nuget
  • pypi
  • swift
  • GetRepositoryPermissionsPolicy : Returns the resource policy that is set on a repository.
  • ListAllowedRepositoriesForGroup : Lists the allowed repositories for a package group that has origin configuration set to ALLOW_SPECIFIC_REPOSITORIES .
  • ListAssociatedPackages : Returns a list of packages associated with the requested package group.
  • ListDomains : Returns a list of DomainSummary objects. Each returned DomainSummary object contains information about a domain.
  • ListPackages : Lists the packages in a repository.
  • ListPackageGroups : Returns a list of package groups in the requested domain.
  • 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 Amazon Web Services account that called this method.
  • ListRepositoriesInDomain : Returns a list of the repositories in a domain.
  • ListSubPackageGroups : Returns a list of direct children of the specified package group.
  • PublishPackageVersion : Creates a new package version containing one or more assets.
  • PutDomainPermissionsPolicy : Attaches a resource policy to a domain.
  • PutPackageOriginConfiguration : Sets the package origin configuration for a package, which determine how new versions of the package can be added to a specific repository.
  • PutRepositoryPermissionsPolicy : Sets the resource policy on a repository that specifies permissions to access it.
  • UpdatePackageGroup : Updates a package group. This API cannot be used to update a package group's origin configuration or pattern.
  • UpdatePackageGroupOriginConfiguration : Updates the package origin configuration for a package group.
  • UpdatePackageVersionsStatus : Updates the status of one or more versions of a package.
  • UpdateRepository : Updates the properties of a repository.

Index

Constants

View Source
const ServiceAPIVersion = "2018-09-22"
View Source
const ServiceID = "codeartifact"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.19.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.22.2

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.22.2

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

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:nuget-org - for the NuGet Gallery.
	//   - 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.
	//   - public:maven-clojars - for the Clojars 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 Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.22.2

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.22.2

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for CodeArtifact.

func New

func New(options Options, optFns ...func(*Options)) *Client

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

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

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 Amazon Web Services 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) CreatePackageGroup added in v1.26.0

func (c *Client) CreatePackageGroup(ctx context.Context, params *CreatePackageGroupInput, optFns ...func(*Options)) (*CreatePackageGroupOutput, error)

Creates a package group. For more information about creating package groups, including example CLI commands, see Create a package group (https://docs.aws.amazon.com/codeartifact/latest/ug/create-package-group.html) in the CodeArtifact User Guide.

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) DeletePackage added in v1.16.0

func (c *Client) DeletePackage(ctx context.Context, params *DeletePackageInput, optFns ...func(*Options)) (*DeletePackageOutput, error)

Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DeletePackageVersions.html) API.

func (*Client) DeletePackageGroup added in v1.26.0

func (c *Client) DeletePackageGroup(ctx context.Context, params *DeletePackageGroupInput, optFns ...func(*Options)) (*DeletePackageGroupOutput, error)

Deletes a package group. Deleting a package group does not delete packages or package versions associated with the package group. When a package group is deleted, the direct child package groups will become children of the package group's direct parent package group. Therefore, if any of the child groups are inheriting any settings from the parent, those settings could change.

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, ListPackageVersions (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, Amazon Web Services 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) DescribePackage added in v1.13.0

func (c *Client) DescribePackage(ctx context.Context, params *DescribePackageInput, optFns ...func(*Options)) (*DescribePackageOutput, error)

Returns a PackageDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html) object that contains information about the requested package.

func (*Client) DescribePackageGroup added in v1.26.0

func (c *Client) DescribePackageGroup(ctx context.Context, params *DescribePackageGroupInput, optFns ...func(*Options)) (*DescribePackageGroupOutput, error)

Returns a PackageGroupDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageGroupDescription.html) object that contains information about the requested package group.

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 ListPackageVersions (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 DescribePackageVersion (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DescribePackageVersion.html) .

func (*Client) GetAssociatedPackageGroup added in v1.26.0

func (c *Client) GetAssociatedPackageGroup(ctx context.Context, params *GetAssociatedPackageGroupInput, optFns ...func(*Options)) (*GetAssociatedPackageGroupOutput, error)

Returns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such, GetAssociatedPackageGroup can be used to see which package group's origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them. For information package group association and matching, see Package group definition syntax and matching behavior (https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html) in the CodeArtifact User Guide.

func (*Client) GetAuthorizationToken

func (c *Client) GetAuthorizationToken(ctx context.Context, params *GetAuthorizationTokenInput, optFns ...func(*Options)) (*GetAuthorizationTokenOutput, error)

Generates a temporary authorization token for accessing repositories in the domain. This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens (https://docs.aws.amazon.com/codeartifact/latest/ug/tokens-authentication.html) . 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 IAM 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. 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:

  • generic
  • maven
  • npm
  • nuget
  • pypi
  • swift

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) ListAllowedRepositoriesForGroup added in v1.26.0

func (c *Client) ListAllowedRepositoriesForGroup(ctx context.Context, params *ListAllowedRepositoriesForGroupInput, optFns ...func(*Options)) (*ListAllowedRepositoriesForGroupOutput, error)

Lists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see Package group origin controls (https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-origin-controls.html) in the CodeArtifact User Guide.

func (*Client) ListAssociatedPackages added in v1.26.0

func (c *Client) ListAssociatedPackages(ctx context.Context, params *ListAssociatedPackagesInput, optFns ...func(*Options)) (*ListAssociatedPackagesOutput, error)

Returns a list of packages associated with the requested package group. For information package group association and matching, see Package group definition syntax and matching behavior (https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html) in the CodeArtifact User Guide.

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 Amazon Web Services account that makes this call. Each returned DomainSummary object contains information about a domain.

func (*Client) ListPackageGroups added in v1.26.0

func (c *Client) ListPackageGroups(ctx context.Context, params *ListPackageGroupsInput, optFns ...func(*Options)) (*ListPackageGroupsOutput, error)

Returns a list of package groups in the requested 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. Package versions of all statuses will be returned by default when calling list-package-versions with no --status parameter.

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 Amazon Web Services 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) ListSubPackageGroups added in v1.26.0

func (c *Client) ListSubPackageGroups(ctx context.Context, params *ListSubPackageGroupsInput, optFns ...func(*Options)) (*ListSubPackageGroupsOutput, error)

Returns a list of direct children of the specified package group. For information package group hierarchy, see Package group definition syntax and matching behavior (https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html) in the CodeArtifact User Guide.

func (*Client) ListTagsForResource added in v0.29.0

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.

func (*Client) Options added in v1.23.0

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PublishPackageVersion added in v1.17.0

func (c *Client) PublishPackageVersion(ctx context.Context, params *PublishPackageVersionInput, optFns ...func(*Options)) (*PublishPackageVersionOutput, error)

Creates a new package version containing one or more assets (or files). The unfinished flag can be used to keep the package version in the Unfinished state until all of its assets have been uploaded (see Package version status (https://docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status.html#package-version-status) in the CodeArtifact user guide). To set the package version’s status to Published , omit the unfinished flag when uploading the final asset, or set the status using UpdatePackageVersionStatus (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html) . Once a package version’s status is set to Published , it cannot change back to Unfinished . Only generic packages can be published using this API. For more information, see Using generic packages (https://docs.aws.amazon.com/codeartifact/latest/ug/using-generic.html) in the CodeArtifact User Guide.

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. When you call PutDomainPermissionsPolicy , the resource policy on the domain is ignored when evaluting permissions. This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being able to update the resource policy.

func (*Client) PutPackageOriginConfiguration added in v1.13.0

func (c *Client) PutPackageOriginConfiguration(ctx context.Context, params *PutPackageOriginConfigurationInput, optFns ...func(*Options)) (*PutPackageOriginConfigurationOutput, error)

Sets the package origin configuration for a package. The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package origin controls and configuration, see Editing package origin controls (https://docs.aws.amazon.com/codeartifact/latest/ug/package-origin-controls.html) in the CodeArtifact User Guide. PutPackageOriginConfiguration can be called on a package that doesn't yet exist in the repository. When called on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.

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. When you call PutRepositoryPermissionsPolicy , the resource policy on the repository is ignored when evaluting permissions. This ensures that the owner of a repository cannot lock themselves out of the repository, which would prevent them from being able to update the resource policy.

func (*Client) TagResource added in v0.29.0

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds or updates tags for a resource in CodeArtifact.

func (*Client) UntagResource added in v0.29.0

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from a resource in CodeArtifact.

func (*Client) UpdatePackageGroup added in v1.26.0

func (c *Client) UpdatePackageGroup(ctx context.Context, params *UpdatePackageGroupInput, optFns ...func(*Options)) (*UpdatePackageGroupOutput, error)

Updates a package group. This API cannot be used to update a package group's origin configuration or pattern. To update a package group's origin configuration, use UpdatePackageGroupOriginConfiguration (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageGroupOriginConfiguration.html) .

func (*Client) UpdatePackageGroupOriginConfiguration added in v1.26.0

func (c *Client) UpdatePackageGroupOriginConfiguration(ctx context.Context, params *UpdatePackageGroupOriginConfigurationInput, optFns ...func(*Options)) (*UpdatePackageGroupOriginConfigurationOutput, error)

Updates the package origin configuration for a package group. The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package group origin controls and configuration, see Package group origin controls (https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-origin-controls.html) in the CodeArtifact User Guide.

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. Using UpdatePackageVersionsStatus , you can update the status of package versions to Archived , Published , or Unlisted . To set the status of a package version to Disposed , use DisposePackageVersions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DisposePackageVersions.html) .

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 versions to be copied.
	//
	// This member is required.
	Format types.PackageFormat

	// The name of the package that contains the versions to be copied.
	//
	// This member is required.
	Package *string

	// The name of the repository that contains the package versions to be copied.
	//
	// 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 Amazon Web Services 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 versions to be copied. The package component that
	// specifies its namespace depends on its type. For example: The namespace is
	// required when copying 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.
	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 be copied. You must specify versions or
	// versionRevisions . You cannot specify both.
	Versions []string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type CreateDomainInput

type CreateDomainInput struct {

	// The name of the domain to create. All domain names in an Amazon Web Services
	// Region that are in the same Amazon Web Services 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 Key Management Service API Reference and Key Management Service API
	// Permissions Reference (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html)
	// in the 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 Key Management Service Developer Guide.
	EncryptionKey *string

	// One or more tag key-value pairs for the domain.
	Tags []types.Tag
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type CreatePackageGroupInput added in v1.26.0

type CreatePackageGroupInput struct {

	// The name of the domain in which you want to create a package group.
	//
	// This member is required.
	Domain *string

	// The pattern of the package group to create. The pattern is also the identifier
	// of the package group.
	//
	// This member is required.
	PackageGroup *string

	// The contact information for the created package group.
	ContactInfo *string

	// A description of the package group.
	Description *string

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

	// One or more tag key-value pairs for the package group.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreatePackageGroupOutput added in v1.26.0

type CreatePackageGroupOutput struct {

	// Information about the created package group after processing the request.
	PackageGroup *types.PackageGroupDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRepositoryInput

type CreateRepositoryInput struct {

	// The name of 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 Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string

	// One or more tag key-value pairs for the repository.
	Tags []types.Tag

	// A list of upstream repositories to associate with the repository. The order of
	// the upstream repositories in the list determines their priority order when
	// 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 Amazon Web Services 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type DeletePackageGroupInput added in v1.26.0

type DeletePackageGroupInput struct {

	// The domain that contains the package group to be deleted.
	//
	// This member is required.
	Domain *string

	// The pattern of the package group to be deleted.
	//
	// This member is required.
	PackageGroup *string

	// The 12-digit account number of the Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string
	// contains filtered or unexported fields
}

type DeletePackageGroupOutput added in v1.26.0

type DeletePackageGroupOutput struct {

	// Information about the deleted package group after processing the request.
	PackageGroup *types.PackageGroupDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePackageInput added in v1.16.0

type DeletePackageInput struct {

	// The name of the domain that contains the package to delete.
	//
	// This member is required.
	Domain *string

	// The format of the requested package to delete.
	//
	// This member is required.
	Format types.PackageFormat

	// The name of the package to delete.
	//
	// This member is required.
	Package *string

	// The name of the repository that contains the package to delete.
	//
	// This member is required.
	Repository *string

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

	// The namespace of the package to delete. The package component that specifies
	// its namespace depends on its type. For example: The namespace is required when
	// deleting packages 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.
	Namespace *string
	// contains filtered or unexported fields
}

type DeletePackageOutput added in v1.16.0

type DeletePackageOutput struct {

	// Details about a package, including its format, namespace, and name.
	DeletedPackage *types.PackageSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

	// The expected status of the package version to delete.
	ExpectedStatus types.PackageVersionStatus

	// The namespace of the package versions to be deleted. The package component that
	// specifies its namespace depends on its type. For example: The namespace is
	// required when deleting 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.
	Namespace *string
	// contains filtered or unexported fields
}

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. The status of
	// every successful version will be Deleted .
	SuccessfulVersions map[string]types.SuccessfulPackageVersionInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 Amazon Web Services 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type DescribePackageGroupInput added in v1.26.0

type DescribePackageGroupInput struct {

	// The name of the domain that contains the package group.
	//
	// This member is required.
	Domain *string

	// The pattern of the requested package group.
	//
	// This member is required.
	PackageGroup *string

	// The 12-digit account number of the Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string
	// contains filtered or unexported fields
}

type DescribePackageGroupOutput added in v1.26.0

type DescribePackageGroupOutput struct {

	// A PackageGroupDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageGroupDescription.html)
	// object that contains information about the requested package group.
	PackageGroup *types.PackageGroupDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribePackageInput added in v1.13.0

type DescribePackageInput struct {

	// The name of the domain that contains the repository that contains the package.
	//
	// This member is required.
	Domain *string

	// A format that specifies the type of the requested package.
	//
	// This member is required.
	Format types.PackageFormat

	// The name of the requested package.
	//
	// This member is required.
	Package *string

	// The name of the repository that contains the requested package.
	//
	// This member is required.
	Repository *string

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

	// The namespace of the requested package. The package component that specifies
	// its namespace depends on its type. For example: The namespace is required when
	// requesting packages 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.
	Namespace *string
	// contains filtered or unexported fields
}

type DescribePackageOutput added in v1.13.0

type DescribePackageOutput struct {

	// A PackageDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html)
	// object that contains information about the requested package.
	//
	// This member is required.
	Package *types.PackageDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

	// The namespace of the requested package version. The package component that
	// specifies its namespace depends on its type. For example: The namespace is
	// required when requesting 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.
	Namespace *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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

	// The expected status of the package version to dispose.
	ExpectedStatus types.PackageVersionStatus

	// The namespace of the package versions to be disposed. The package component
	// that specifies its namespace depends on its type. For example: The namespace is
	// required when disposing 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.
	Namespace *string

	// The revisions of the package versions you want to dispose.
	VersionRevisions map[string]string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.19.0

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.19.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.19.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (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 EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.19.0

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.19.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAssociatedPackageGroupInput added in v1.26.0

type GetAssociatedPackageGroupInput struct {

	// The name of the domain that contains the package from which to get the
	// associated package group.
	//
	// This member is required.
	Domain *string

	// The format of the package from which to get the associated package group.
	//
	// This member is required.
	Format types.PackageFormat

	// The package from which to get the associated package group.
	//
	// This member is required.
	Package *string

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

	// The namespace of the package from which to get the associated package group.
	// The package component that specifies its namespace depends on its type. For
	// example: The namespace is required when getting associated package groups from
	// packages 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.
	Namespace *string
	// contains filtered or unexported fields
}

type GetAssociatedPackageGroupOutput added in v1.26.0

type GetAssociatedPackageGroupOutput struct {

	// Describes the strength of the association between the package and package
	// group. A strong match is also known as an exact match, and a weak match is known
	// as a relative match.
	AssociationType types.PackageGroupAssociationType

	// The package group that is associated with the requested package.
	PackageGroup *types.PackageGroupDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 Amazon Web Services 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. Valid
	// values are 0 and any number between 900 (15 minutes) and 43200 (12 hours). A
	// value of 0 will set the expiration of the authorization token to the same
	// expiration of the user's role's temporary credentials.
	DurationSeconds *int64
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string
	// contains filtered or unexported fields
}

type GetDomainPermissionsPolicyOutput

type GetDomainPermissionsPolicyOutput struct {

	// The returned resource policy.
	Policy *types.ResourcePolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPackageVersionAssetInput

type GetPackageVersionAssetInput struct {

	// The name of the requested asset.
	//
	// This member is required.
	Asset *string

	// The name of 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.
	//
	// 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 Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string

	// The namespace of the package version with the requested asset file. The package
	// component that specifies its namespace depends on its type. For example: The
	// namespace is required when requesting assets 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.
	Namespace *string

	// The name of the package version revision that contains the requested asset.
	PackageVersionRevision *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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

	// 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.
	Namespace *string
	// contains filtered or unexported fields
}

type GetPackageVersionReadmeOutput

type GetPackageVersionReadmeOutput struct {

	// The format of the package with the requested readme file.
	Format types.PackageFormat

	// 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 and NuGet package versions do not contain a corresponding component,
	//   package versions of those formats 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
	// contains filtered or unexported fields
}

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.
	//
	// 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 Amazon Web Services account that owns the
	// domain that contains the repository. It does not include dashes or spaces.
	DomainOwner *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string
	// contains filtered or unexported fields
}

type GetRepositoryPermissionsPolicyOutput

type GetRepositoryPermissionsPolicyOutput struct {

	// The returned resource policy.
	Policy *types.ResourcePolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListAllowedRepositoriesForGroupAPIClient added in v1.26.0

type ListAllowedRepositoriesForGroupAPIClient interface {
	ListAllowedRepositoriesForGroup(context.Context, *ListAllowedRepositoriesForGroupInput, ...func(*Options)) (*ListAllowedRepositoriesForGroupOutput, error)
}

ListAllowedRepositoriesForGroupAPIClient is a client that implements the ListAllowedRepositoriesForGroup operation.

type ListAllowedRepositoriesForGroupInput added in v1.26.0

type ListAllowedRepositoriesForGroupInput struct {

	// The name of the domain that contains the package group from which to list
	// allowed repositories.
	//
	// This member is required.
	Domain *string

	// The origin configuration restriction type of which to list allowed repositories.
	//
	// This member is required.
	OriginRestrictionType types.PackageGroupOriginRestrictionType

	// The pattern of the package group from which to list allowed repositories.
	//
	// This member is required.
	PackageGroup *string

	// The 12-digit account number of the Amazon Web Services 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
	// contains filtered or unexported fields
}

type ListAllowedRepositoriesForGroupOutput added in v1.26.0

type ListAllowedRepositoriesForGroupOutput struct {

	// The list of allowed repositories for the package group and origin configuration
	// restriction type.
	AllowedRepositories []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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAllowedRepositoriesForGroupPaginator added in v1.26.0

type ListAllowedRepositoriesForGroupPaginator struct {
	// contains filtered or unexported fields
}

ListAllowedRepositoriesForGroupPaginator is a paginator for ListAllowedRepositoriesForGroup

func NewListAllowedRepositoriesForGroupPaginator added in v1.26.0

NewListAllowedRepositoriesForGroupPaginator returns a new ListAllowedRepositoriesForGroupPaginator

func (*ListAllowedRepositoriesForGroupPaginator) HasMorePages added in v1.26.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAllowedRepositoriesForGroupPaginator) NextPage added in v1.26.0

NextPage retrieves the next ListAllowedRepositoriesForGroup page.

type ListAllowedRepositoriesForGroupPaginatorOptions added in v1.26.0

type ListAllowedRepositoriesForGroupPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAllowedRepositoriesForGroupPaginatorOptions is the paginator options for ListAllowedRepositoriesForGroup

type ListAssociatedPackagesAPIClient added in v1.26.0

type ListAssociatedPackagesAPIClient interface {
	ListAssociatedPackages(context.Context, *ListAssociatedPackagesInput, ...func(*Options)) (*ListAssociatedPackagesOutput, error)
}

ListAssociatedPackagesAPIClient is a client that implements the ListAssociatedPackages operation.

type ListAssociatedPackagesInput added in v1.26.0

type ListAssociatedPackagesInput struct {

	// The name of the domain that contains the package group from which to list
	// associated packages.
	//
	// This member is required.
	Domain *string

	// The pattern of the package group from which to list associated packages.
	//
	// This member is required.
	PackageGroup *string

	// The 12-digit account number of the Amazon Web Services 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

	// When this flag is included, ListAssociatedPackages will return a list of
	// packages that would be associated with a package group, even if it does not
	// exist.
	Preview *bool
	// contains filtered or unexported fields
}

type ListAssociatedPackagesOutput added in v1.26.0

type ListAssociatedPackagesOutput struct {

	// 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 list of packages associated with the requested package group.
	Packages []types.AssociatedPackage

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAssociatedPackagesPaginator added in v1.26.0

type ListAssociatedPackagesPaginator struct {
	// contains filtered or unexported fields
}

ListAssociatedPackagesPaginator is a paginator for ListAssociatedPackages

func NewListAssociatedPackagesPaginator added in v1.26.0

NewListAssociatedPackagesPaginator returns a new ListAssociatedPackagesPaginator

func (*ListAssociatedPackagesPaginator) HasMorePages added in v1.26.0

func (p *ListAssociatedPackagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssociatedPackagesPaginator) NextPage added in v1.26.0

NextPage retrieves the next ListAssociatedPackages page.

type ListAssociatedPackagesPaginatorOptions added in v1.26.0

type ListAssociatedPackagesPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAssociatedPackagesPaginatorOptions is the paginator options for ListAssociatedPackages

type ListDomainsAPIClient added in v0.30.0

type ListDomainsAPIClient interface {
	ListDomains(context.Context, *ListDomainsInput, ...func(*Options)) (*ListDomainsOutput, error)
}

ListDomainsAPIClient is a client that implements the ListDomains operation.

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListDomainsPaginator added in v0.30.0

type ListDomainsPaginator struct {
	// contains filtered or unexported fields
}

ListDomainsPaginator is a paginator for ListDomains

func NewListDomainsPaginator added in v0.30.0

func NewListDomainsPaginator(client ListDomainsAPIClient, params *ListDomainsInput, optFns ...func(*ListDomainsPaginatorOptions)) *ListDomainsPaginator

NewListDomainsPaginator returns a new ListDomainsPaginator

func (*ListDomainsPaginator) HasMorePages added in v0.30.0

func (p *ListDomainsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDomainsPaginator) NextPage added in v0.30.0

func (p *ListDomainsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDomainsOutput, error)

NextPage retrieves the next ListDomains page.

type ListDomainsPaginatorOptions added in v0.30.0

type ListDomainsPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDomainsPaginatorOptions is the paginator options for ListDomains

type ListPackageGroupsAPIClient added in v1.26.0

type ListPackageGroupsAPIClient interface {
	ListPackageGroups(context.Context, *ListPackageGroupsInput, ...func(*Options)) (*ListPackageGroupsOutput, error)
}

ListPackageGroupsAPIClient is a client that implements the ListPackageGroups operation.

type ListPackageGroupsInput added in v1.26.0

type ListPackageGroupsInput struct {

	// The domain for which you want to list package groups.
	//
	// This member is required.
	Domain *string

	// The 12-digit account number of the Amazon Web Services 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 for which to search package groups. When included, ListPackageGroups
	// will return only package groups with patterns that match the prefix.
	Prefix *string
	// contains filtered or unexported fields
}

type ListPackageGroupsOutput added in v1.26.0

type ListPackageGroupsOutput struct {

	// 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 list of package groups in the requested domain.
	PackageGroups []types.PackageGroupSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPackageGroupsPaginator added in v1.26.0

type ListPackageGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListPackageGroupsPaginator is a paginator for ListPackageGroups

func NewListPackageGroupsPaginator added in v1.26.0

func NewListPackageGroupsPaginator(client ListPackageGroupsAPIClient, params *ListPackageGroupsInput, optFns ...func(*ListPackageGroupsPaginatorOptions)) *ListPackageGroupsPaginator

NewListPackageGroupsPaginator returns a new ListPackageGroupsPaginator

func (*ListPackageGroupsPaginator) HasMorePages added in v1.26.0

func (p *ListPackageGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPackageGroupsPaginator) NextPage added in v1.26.0

func (p *ListPackageGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPackageGroupsOutput, error)

NextPage retrieves the next ListPackageGroups page.

type ListPackageGroupsPaginatorOptions added in v1.26.0

type ListPackageGroupsPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPackageGroupsPaginatorOptions is the paginator options for ListPackageGroups

type ListPackageVersionAssetsAPIClient added in v0.30.0

type ListPackageVersionAssetsAPIClient interface {
	ListPackageVersionAssets(context.Context, *ListPackageVersionAssetsInput, ...func(*Options)) (*ListPackageVersionAssetsOutput, error)
}

ListPackageVersionAssetsAPIClient is a client that implements the ListPackageVersionAssets operation.

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 requested package version assets.
	//
	// This member is required.
	Format types.PackageFormat

	// The name of the package that contains the requested 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
	// requested package version assets.
	//
	// This member is required.
	Repository *string

	// The 12-digit account number of the Amazon Web Services 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 version that contains the requested package
	// version assets. The package component that specifies its namespace depends on
	// its type. For example: The namespace is required requesting assets 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.
	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
	// contains filtered or unexported fields
}

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 requested package version assets.
	Format types.PackageFormat

	// The namespace of the package version that contains the requested package
	// version assets. 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 and NuGet package versions do not contain a corresponding component,
	//   package versions of those formats 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 requested package version assets.
	Package *string

	// The version of the package associated with the requested assets.
	Version *string

	// The current revision associated with the package version.
	VersionRevision *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPackageVersionAssetsPaginator added in v0.30.0

type ListPackageVersionAssetsPaginator struct {
	// contains filtered or unexported fields
}

ListPackageVersionAssetsPaginator is a paginator for ListPackageVersionAssets

func NewListPackageVersionAssetsPaginator added in v0.30.0

NewListPackageVersionAssetsPaginator returns a new ListPackageVersionAssetsPaginator

func (*ListPackageVersionAssetsPaginator) HasMorePages added in v0.30.0

func (p *ListPackageVersionAssetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPackageVersionAssetsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListPackageVersionAssets page.

type ListPackageVersionAssetsPaginatorOptions added in v0.30.0

type ListPackageVersionAssetsPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPackageVersionAssetsPaginatorOptions is the paginator options for ListPackageVersionAssets

type ListPackageVersionDependenciesInput

type ListPackageVersionDependenciesInput struct {

	// The name of 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.
	//
	// 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 Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string

	// The namespace of the package version with the requested dependencies. The
	// package component that specifies its namespace depends on its type. For example:
	// The namespace is required when listing dependencies 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.
	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
	// contains filtered or unexported fields
}

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.
	Format types.PackageFormat

	// The namespace of the package version that contains the returned dependencies.
	// 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 and NuGet package versions do not contain a corresponding component,
	//   package versions of those formats 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
	// contains filtered or unexported fields
}

type ListPackageVersionsAPIClient added in v0.30.0

type ListPackageVersionsAPIClient interface {
	ListPackageVersions(context.Context, *ListPackageVersionsInput, ...func(*Options)) (*ListPackageVersionsOutput, error)
}

ListPackageVersionsAPIClient is a client that implements the ListPackageVersions operation.

type ListPackageVersionsInput

type ListPackageVersionsInput struct {

	// The name of the domain that contains the repository that contains the requested
	// package versions.
	//
	// This member is required.
	Domain *string

	// The format of the package versions you want to list.
	//
	// This member is required.
	Format types.PackageFormat

	// The name of the package for which you want to request package versions.
	//
	// This member is required.
	Package *string

	// The name of the repository that contains the requested package versions.
	//
	// This member is required.
	Repository *string

	// The 12-digit account number of the Amazon Web Services 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 that contains the requested package versions. The
	// package component that specifies its namespace depends on its type. For example:
	// The namespace is required when deleting 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.
	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 originType used to filter package versions. Only package versions with the
	// provided originType will be returned.
	OriginType types.PackageVersionOriginType

	// How to sort the requested list of package versions.
	SortBy types.PackageVersionSortType

	// A string that filters the requested package versions by status.
	Status types.PackageVersionStatus
	// contains filtered or unexported fields
}

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.
	Format types.PackageFormat

	// The namespace of the package that contains the requested package versions. 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 and NuGet package versions do not contain a corresponding component,
	//   package versions of those formats 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
	// contains filtered or unexported fields
}

type ListPackageVersionsPaginator added in v0.30.0

type ListPackageVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListPackageVersionsPaginator is a paginator for ListPackageVersions

func NewListPackageVersionsPaginator added in v0.30.0

func NewListPackageVersionsPaginator(client ListPackageVersionsAPIClient, params *ListPackageVersionsInput, optFns ...func(*ListPackageVersionsPaginatorOptions)) *ListPackageVersionsPaginator

NewListPackageVersionsPaginator returns a new ListPackageVersionsPaginator

func (*ListPackageVersionsPaginator) HasMorePages added in v0.30.0

func (p *ListPackageVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPackageVersionsPaginator) NextPage added in v0.30.0

func (p *ListPackageVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPackageVersionsOutput, error)

NextPage retrieves the next ListPackageVersions page.

type ListPackageVersionsPaginatorOptions added in v0.30.0

type ListPackageVersionsPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPackageVersionsPaginatorOptions is the paginator options for ListPackageVersions

type ListPackagesAPIClient added in v0.30.0

type ListPackagesAPIClient interface {
	ListPackages(context.Context, *ListPackagesInput, ...func(*Options)) (*ListPackagesOutput, error)
}

ListPackagesAPIClient is a client that implements the ListPackages operation.

type ListPackagesInput

type ListPackagesInput struct {

	// The name of the domain that contains the repository that contains the requested
	// packages.
	//
	// This member is required.
	Domain *string

	// The name of the repository that contains the requested packages.
	//
	// This member is required.
	Repository *string

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

	// The format used to filter requested packages. Only packages from the provided
	// format will be returned.
	Format types.PackageFormat

	// The maximum number of results to return per page.
	MaxResults *int32

	// The namespace prefix used to filter requested packages. Only packages with a
	// namespace that starts with the provided string value are returned. Note that
	// although this option is called --namespace and not --namespace-prefix , it has
	// prefix-matching behavior. Each package format uses namespace as follows:
	//   - 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.
	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 requested packages. Only packages with names that start
	// with packagePrefix are returned.
	PackagePrefix *string

	// The value of the Publish package origin control restriction used to filter
	// requested packages. Only packages with the provided restriction are returned.
	// For more information, see PackageOriginRestrictions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html)
	// .
	Publish types.AllowPublish

	// The value of the Upstream package origin control restriction used to filter
	// requested packages. Only packages with the provided restriction are returned.
	// For more information, see PackageOriginRestrictions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html)
	// .
	Upstream types.AllowUpstream
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListPackagesPaginator added in v0.30.0

type ListPackagesPaginator struct {
	// contains filtered or unexported fields
}

ListPackagesPaginator is a paginator for ListPackages

func NewListPackagesPaginator added in v0.30.0

func NewListPackagesPaginator(client ListPackagesAPIClient, params *ListPackagesInput, optFns ...func(*ListPackagesPaginatorOptions)) *ListPackagesPaginator

NewListPackagesPaginator returns a new ListPackagesPaginator

func (*ListPackagesPaginator) HasMorePages added in v0.30.0

func (p *ListPackagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPackagesPaginator) NextPage added in v0.30.0

func (p *ListPackagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPackagesOutput, error)

NextPage retrieves the next ListPackages page.

type ListPackagesPaginatorOptions added in v0.30.0

type ListPackagesPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPackagesPaginatorOptions is the paginator options for ListPackages

type ListRepositoriesAPIClient added in v0.30.0

type ListRepositoriesAPIClient interface {
	ListRepositories(context.Context, *ListRepositoriesInput, ...func(*Options)) (*ListRepositoriesOutput, error)
}

ListRepositoriesAPIClient is a client that implements the ListRepositories operation.

type ListRepositoriesInDomainAPIClient added in v0.30.0

type ListRepositoriesInDomainAPIClient interface {
	ListRepositoriesInDomain(context.Context, *ListRepositoriesInDomainInput, ...func(*Options)) (*ListRepositoriesInDomainOutput, error)
}

ListRepositoriesInDomainAPIClient is a client that implements the ListRepositoriesInDomain operation.

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
	// Amazon Web Services account ID.
	AdministratorAccount *string

	// The 12-digit account number of the Amazon Web Services 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListRepositoriesInDomainPaginator added in v0.30.0

type ListRepositoriesInDomainPaginator struct {
	// contains filtered or unexported fields
}

ListRepositoriesInDomainPaginator is a paginator for ListRepositoriesInDomain

func NewListRepositoriesInDomainPaginator added in v0.30.0

NewListRepositoriesInDomainPaginator returns a new ListRepositoriesInDomainPaginator

func (*ListRepositoriesInDomainPaginator) HasMorePages added in v0.30.0

func (p *ListRepositoriesInDomainPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRepositoriesInDomainPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListRepositoriesInDomain page.

type ListRepositoriesInDomainPaginatorOptions added in v0.30.0

type ListRepositoriesInDomainPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRepositoriesInDomainPaginatorOptions is the paginator options for ListRepositoriesInDomain

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListRepositoriesPaginator added in v0.30.0

type ListRepositoriesPaginator struct {
	// contains filtered or unexported fields
}

ListRepositoriesPaginator is a paginator for ListRepositories

func NewListRepositoriesPaginator added in v0.30.0

func NewListRepositoriesPaginator(client ListRepositoriesAPIClient, params *ListRepositoriesInput, optFns ...func(*ListRepositoriesPaginatorOptions)) *ListRepositoriesPaginator

NewListRepositoriesPaginator returns a new ListRepositoriesPaginator

func (*ListRepositoriesPaginator) HasMorePages added in v0.30.0

func (p *ListRepositoriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRepositoriesPaginator) NextPage added in v0.30.0

func (p *ListRepositoriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRepositoriesOutput, error)

NextPage retrieves the next ListRepositories page.

type ListRepositoriesPaginatorOptions added in v0.30.0

type ListRepositoriesPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRepositoriesPaginatorOptions is the paginator options for ListRepositories

type ListSubPackageGroupsAPIClient added in v1.26.0

type ListSubPackageGroupsAPIClient interface {
	ListSubPackageGroups(context.Context, *ListSubPackageGroupsInput, ...func(*Options)) (*ListSubPackageGroupsOutput, error)
}

ListSubPackageGroupsAPIClient is a client that implements the ListSubPackageGroups operation.

type ListSubPackageGroupsInput added in v1.26.0

type ListSubPackageGroupsInput struct {

	// The name of the domain which contains the package group from which to list sub
	// package groups.
	//
	// This member is required.
	Domain *string

	// The pattern of the package group from which to list sub package groups.
	//
	// This member is required.
	PackageGroup *string

	// The 12-digit account number of the Amazon Web Services 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
	// contains filtered or unexported fields
}

type ListSubPackageGroupsOutput added in v1.26.0

type ListSubPackageGroupsOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

	// A list of sub package groups for the requested package group.
	PackageGroups []types.PackageGroupSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSubPackageGroupsPaginator added in v1.26.0

type ListSubPackageGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListSubPackageGroupsPaginator is a paginator for ListSubPackageGroups

func NewListSubPackageGroupsPaginator added in v1.26.0

NewListSubPackageGroupsPaginator returns a new ListSubPackageGroupsPaginator

func (*ListSubPackageGroupsPaginator) HasMorePages added in v1.26.0

func (p *ListSubPackageGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSubPackageGroupsPaginator) NextPage added in v1.26.0

NextPage retrieves the next ListSubPackageGroups page.

type ListSubPackageGroupsPaginatorOptions added in v1.26.0

type ListSubPackageGroupsPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSubPackageGroupsPaginatorOptions is the paginator options for ListSubPackageGroups

type ListTagsForResourceInput added in v0.29.0

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to get tags for.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v0.29.0

type ListTagsForResourceOutput struct {

	// A list of tag key and value pairs associated with the specified resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.22.2

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PublishPackageVersionInput added in v1.17.0

type PublishPackageVersionInput struct {

	// The content of the asset to publish.
	//
	// This member is required.
	AssetContent io.Reader

	// The name of the asset to publish. Asset names can include Unicode letters and
	// numbers, and the following special characters: ~ ! @ ^ & ( ) - ` _ + [ ] { } ;
	// , . `
	//
	// This member is required.
	AssetName *string

	// The SHA256 hash of the assetContent to publish. This value must be calculated
	// by the caller and provided with the request (see Publishing a generic package (https://docs.aws.amazon.com/codeartifact/latest/ug/using-generic.html#publishing-generic-packages)
	// in the CodeArtifact User Guide). This value is used as an integrity check to
	// verify that the assetContent has not changed after it was originally sent.
	//
	// This member is required.
	AssetSHA256 *string

	// The name of the domain that contains the repository that contains the package
	// version to publish.
	//
	// This member is required.
	Domain *string

	// A format that specifies the type of the package version with the requested
	// asset file. The only supported value is generic .
	//
	// This member is required.
	Format types.PackageFormat

	// The name of the package version to publish.
	//
	// This member is required.
	Package *string

	// The package version to publish (for example, 3.5.2 ).
	//
	// This member is required.
	PackageVersion *string

	// The name of the repository that the package version will be published to.
	//
	// 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 version to publish.
	Namespace *string

	// Specifies whether the package version should remain in the unfinished state. If
	// omitted, the package version status will be set to Published (see Package
	// version status (https://docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status)
	// in the CodeArtifact User Guide). Valid values: unfinished
	Unfinished *bool
	// contains filtered or unexported fields
}

type PublishPackageVersionOutput added in v1.17.0

type PublishPackageVersionOutput struct {

	// An AssetSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html)
	// for the published asset.
	Asset *types.AssetSummary

	// The format of the package version.
	Format types.PackageFormat

	// The namespace of the package version.
	Namespace *string

	// The name of the package.
	Package *string

	// A string that contains the status of the package version. For more information,
	// see Package version status (https://docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status.html#package-version-status)
	// in the CodeArtifact User Guide.
	Status types.PackageVersionStatus

	// The version of the package.
	Version *string

	// The revision of the package version.
	VersionRevision *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 Amazon Web Services 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type PutPackageOriginConfigurationInput added in v1.13.0

type PutPackageOriginConfigurationInput struct {

	// The name of the domain that contains the repository that contains the package.
	//
	// This member is required.
	Domain *string

	// A format that specifies the type of the package to be updated.
	//
	// This member is required.
	Format types.PackageFormat

	// The name of the package to be updated.
	//
	// This member is required.
	Package *string

	// The name of the repository that contains the package.
	//
	// This member is required.
	Repository *string

	// A PackageOriginRestrictions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html)
	// object that contains information about the upstream and publish package origin
	// restrictions. The upstream restriction determines if new package versions can
	// be ingested or retained from external connections or upstream repositories. The
	// publish restriction determines if new package versions can be published directly
	// to the repository. You must include both the desired upstream and publish
	// restrictions.
	//
	// This member is required.
	Restrictions *types.PackageOriginRestrictions

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

	// The namespace of the package to be updated. 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 and NuGet package versions do not contain a corresponding component,
	//   package versions of those formats do not have a namespace.
	Namespace *string
	// contains filtered or unexported fields
}

type PutPackageOriginConfigurationOutput added in v1.13.0

type PutPackageOriginConfigurationOutput struct {

	// A PackageOriginConfiguration (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginConfiguration.html)
	// object that describes the origin configuration set for the package. It contains
	// a PackageOriginRestrictions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html)
	// object that describes how new versions of the package can be introduced to the
	// repository.
	OriginConfiguration *types.PackageOriginConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 Amazon Web Services 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type TagResourceInput added in v0.29.0

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to add or update
	// tags for.
	//
	// This member is required.
	ResourceArn *string

	// The tags you want to modify or add to the resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput added in v0.29.0

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput added in v0.29.0

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to remove tags
	// from.
	//
	// This member is required.
	ResourceArn *string

	// The tag key for each tag that you want to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput added in v0.29.0

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePackageGroupInput added in v1.26.0

type UpdatePackageGroupInput struct {

	// The name of the domain which contains the package group to be updated.
	//
	// This member is required.
	Domain *string

	// The pattern of the package group to be updated.
	//
	// This member is required.
	PackageGroup *string

	// Contact information which you want to update the requested package group with.
	ContactInfo *string

	// The description you want to update the requested package group with.
	Description *string

	// The 12-digit account number of the Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string
	// contains filtered or unexported fields
}

type UpdatePackageGroupOriginConfigurationInput added in v1.26.0

type UpdatePackageGroupOriginConfigurationInput struct {

	// The name of the domain which contains the package group for which to update the
	// origin configuration.
	//
	// This member is required.
	Domain *string

	// The pattern of the package group for which to update the origin configuration.
	//
	// This member is required.
	PackageGroup *string

	// The repository name and restrictions to add to the allowed repository list of
	// the specified package group.
	AddAllowedRepositories []types.PackageGroupAllowedRepository

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

	// The repository name and restrictions to remove from the allowed repository list
	// of the specified package group.
	RemoveAllowedRepositories []types.PackageGroupAllowedRepository

	// The origin configuration settings that determine how package versions can enter
	// repositories.
	Restrictions map[string]types.PackageGroupOriginRestrictionMode
	// contains filtered or unexported fields
}

type UpdatePackageGroupOriginConfigurationOutput added in v1.26.0

type UpdatePackageGroupOriginConfigurationOutput struct {

	// Information about the updated allowed repositories after processing the request.
	AllowedRepositoryUpdates map[string]map[string][]string

	// The package group and information about it after processing the request.
	PackageGroup *types.PackageGroupDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePackageGroupOutput added in v1.26.0

type UpdatePackageGroupOutput struct {

	// The package group and information about it after the request has been processed.
	PackageGroup *types.PackageGroupDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePackageVersionsStatusInput

type UpdatePackageVersionsStatusInput struct {

	// The name of 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.
	//
	// 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 Amazon Web Services 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 version to be updated. 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 and NuGet package versions do not contain a corresponding component,
	//   package versions of those formats 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 Amazon Web Services 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
	// 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
	// contains filtered or unexported fields
}

type UpdateRepositoryOutput

type UpdateRepositoryOutput struct {

	// The updated repository.
	Repository *types.RepositoryDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL