github.com/aavshr/aws-sdk-go@v1.41.3/service/codeartifact/doc.go (about) 1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. 2 3 // Package codeartifact provides the client and types for making API 4 // requests to CodeArtifact. 5 // 6 // AWS CodeArtifact is a fully managed artifact repository compatible with language-native 7 // package managers and build tools such as npm, Apache Maven, and pip. You 8 // can use CodeArtifact to share packages with development teams and pull packages. 9 // Packages can be pulled from both public and CodeArtifact repositories. You 10 // can also create an upstream relationship between a CodeArtifact repository 11 // and another repository, which effectively merges their contents from the 12 // point of view of a package manager client. 13 // 14 // AWS CodeArtifact Components 15 // 16 // Use the information in this guide to help you work with the following CodeArtifact 17 // components: 18 // 19 // * Repository: A CodeArtifact repository contains a set of package versions 20 // (https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version), 21 // each of which maps to a set of assets, or files. Repositories are polyglot, 22 // so a single repository can contain packages of any supported type. Each 23 // repository exposes endpoints for fetching and publishing packages using 24 // tools like the npm CLI, the Maven CLI ( mvn ), and pip . 25 // 26 // * Domain: Repositories are aggregated into a higher-level entity known 27 // as a domain. All package assets and metadata are stored in the domain, 28 // but are consumed through repositories. A given package asset, such as 29 // a Maven JAR file, is stored once per domain, no matter how many repositories 30 // it's present in. All of the assets and metadata in a domain are encrypted 31 // with the same customer master key (CMK) stored in AWS Key Management Service 32 // (AWS KMS). Each repository is a member of a single domain and can't be 33 // moved to a different domain. The domain allows organizational policy to 34 // be applied across multiple repositories, such as which accounts can access 35 // repositories in the domain, and which public repositories can be used 36 // as sources of packages. Although an organization can have multiple domains, 37 // we recommend a single production domain that contains all published artifacts 38 // so that teams can find and share packages across their organization. 39 // 40 // * Package: A package is a bundle of software and the metadata required 41 // to resolve dependencies and install the software. CodeArtifact supports 42 // npm (https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html), 43 // PyPI (https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html), 44 // and Maven (https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven) 45 // package formats. In CodeArtifact, a package consists of: A name (for example, 46 // webpack is the name of a popular npm package) An optional namespace (for 47 // example, @types in @types/node) A set of versions (for example, 1.0.0, 48 // 1.0.1, 1.0.2, etc.) Package-level metadata (for example, npm tags) 49 // 50 // * Package version: A version of a package, such as @types/node 12.6.9. 51 // The version number format and semantics vary for different package formats. 52 // For example, npm package versions must conform to the Semantic Versioning 53 // specification (https://semver.org/). In CodeArtifact, a package version 54 // consists of the version identifier, metadata at the package version level, 55 // and a set of assets. 56 // 57 // * Upstream repository: One repository is upstream of another when the 58 // package versions in it can be accessed from the repository endpoint of 59 // the downstream repository, effectively merging the contents of the two 60 // repositories from the point of view of a client. CodeArtifact allows creating 61 // an upstream relationship between two repositories. 62 // 63 // * Asset: An individual file stored in CodeArtifact associated with a package 64 // version, such as an npm .tgz file or Maven POM and JAR files. 65 // 66 // CodeArtifact supports these operations: 67 // 68 // * AssociateExternalConnection: Adds an existing external connection to 69 // a repository. 70 // 71 // * CopyPackageVersions: Copies package versions from one repository to 72 // another repository in the same domain. 73 // 74 // * CreateDomain: Creates a domain 75 // 76 // * CreateRepository: Creates a CodeArtifact repository in a domain. 77 // 78 // * DeleteDomain: Deletes a domain. You cannot delete a domain that contains 79 // repositories. 80 // 81 // * DeleteDomainPermissionsPolicy: Deletes the resource policy that is set 82 // on a domain. 83 // 84 // * DeletePackageVersions: Deletes versions of a package. After a package 85 // has been deleted, it can be republished, but its assets and metadata cannot 86 // be restored because they have been permanently removed from storage. 87 // 88 // * DeleteRepository: Deletes a repository. 89 // 90 // * DeleteRepositoryPermissionsPolicy: Deletes the resource policy that 91 // is set on a repository. 92 // 93 // * DescribeDomain: Returns a DomainDescription object that contains information 94 // about the requested domain. 95 // 96 // * DescribePackageVersion: Returns a PackageVersionDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) 97 // object that contains details about a package version. 98 // 99 // * DescribeRepository: Returns a RepositoryDescription object that contains 100 // detailed information about the requested repository. 101 // 102 // * DisposePackageVersions: Disposes versions of a package. A package version 103 // with the status Disposed cannot be restored because they have been permanently 104 // removed from storage. 105 // 106 // * DisassociateExternalConnection: Removes an existing external connection 107 // from a repository. 108 // 109 // * GetAuthorizationToken: Generates a temporary authorization token for 110 // accessing repositories in the domain. The token expires the authorization 111 // period has passed. The default authorization period is 12 hours and can 112 // be customized to any length with a maximum of 12 hours. 113 // 114 // * GetDomainPermissionsPolicy: Returns the policy of a resource that is 115 // attached to the specified domain. 116 // 117 // * GetPackageVersionAsset: Returns the contents of an asset that is in 118 // a package version. 119 // 120 // * GetPackageVersionReadme: Gets the readme file or descriptive text for 121 // a package version. 122 // 123 // * GetRepositoryEndpoint: Returns the endpoint of a repository for a specific 124 // package format. A repository has one endpoint for each package format: 125 // npm pypi maven 126 // 127 // * GetRepositoryPermissionsPolicy: Returns the resource policy that is 128 // set on a repository. 129 // 130 // * ListDomains: Returns a list of DomainSummary objects. Each returned 131 // DomainSummary object contains information about a domain. 132 // 133 // * ListPackages: Lists the packages in a repository. 134 // 135 // * ListPackageVersionAssets: Lists the assets for a given package version. 136 // 137 // * ListPackageVersionDependencies: Returns a list of the direct dependencies 138 // for a package version. 139 // 140 // * ListPackageVersions: Returns a list of package versions for a specified 141 // package in a repository. 142 // 143 // * ListRepositories: Returns a list of repositories owned by the AWS account 144 // that called this method. 145 // 146 // * ListRepositoriesInDomain: Returns a list of the repositories in a domain. 147 // 148 // * PutDomainPermissionsPolicy: Attaches a resource policy to a domain. 149 // 150 // * PutRepositoryPermissionsPolicy: Sets the resource policy on a repository 151 // that specifies permissions to access it. 152 // 153 // * UpdatePackageVersionsStatus: Updates the status of one or more versions 154 // of a package. 155 // 156 // * UpdateRepository: Updates the properties of a repository. 157 // 158 // See https://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22 for more information on this service. 159 // 160 // See codeartifact package documentation for more information. 161 // https://docs.aws.amazon.com/sdk-for-go/api/service/codeartifact/ 162 // 163 // Using the Client 164 // 165 // To contact CodeArtifact with the SDK use the New function to create 166 // a new service client. With that client you can make API requests to the service. 167 // These clients are safe to use concurrently. 168 // 169 // See the SDK's documentation for more information on how to use the SDK. 170 // https://docs.aws.amazon.com/sdk-for-go/api/ 171 // 172 // See aws.Config documentation for more information on configuring SDK clients. 173 // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config 174 // 175 // See the CodeArtifact client CodeArtifact for more 176 // information on creating client for this service. 177 // https://docs.aws.amazon.com/sdk-for-go/api/service/codeartifact/#New 178 package codeartifact