CodeArtifact
Service object for interacting with AWS CodeArtifact service.
public struct CodeArtifact: AWSService
AWS CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, and pip. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.
<p>
<b>AWS CodeArtifact Components</b>
</p>
<p>Use the information in this guide to help you work with the following CodeArtifact components:</p>
<ul>
<li>
<p>
<b>Repository</b>: A CodeArtifact repository contains a set of <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version">package
versions</a>, 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
<b>
<code>npm</code>
</b> CLI, the Maven CLI (<b>
<code>mvn</code>
</b>), and <b>
<code>pip</code>
</b>.</p>
</li>
<li>
<p>
<b>Domain</b>: Repositories are aggregated into a higher-level entity known as a
<i>domain</i>. All package assets and metadata are stored in the domain,
but are consumed through repositories. A given package asset, such as a Maven JAR file, is
stored once per domain, no matter how many repositories it's present in. All of the assets
and metadata in a domain are encrypted with the same customer master key (CMK) stored in
AWS Key Management Service (AWS KMS).</p>
<p>Each repository is a member of a single domain and can't be moved to a
different domain.</p>
<p>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.</p>
<p>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.</p>
</li>
<li>
<p>
<b>Package</b>: A <i>package</i> is a bundle of software and the metadata required to
resolve dependencies and install the software. CodeArtifact supports <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html">npm</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html">PyPI</a>, and <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven">Maven</a> package formats.</p>
<p>In CodeArtifact, a package consists of:</p>
<ul>
<li>
<p>A <i>name</i> (for example, <code>webpack</code> is the name of a
popular npm package)</p>
</li>
<li>
<p>An optional namespace (for example, <code>@types</code> in <code>@types/node</code>)</p>
</li>
<li>
<p>A set of versions (for example, <code>1.0.0</code>, <code>1.0.1</code>,
<code>1.0.2</code>, etc.)</p>
</li>
<li>
<p> Package-level metadata (for example, npm tags)</p>
</li>
</ul>
</li>
<li>
<p>
<b>Package version</b>: A version of a package, such as <code>@types/node 12.6.9</code>. The version number
format and semantics vary for different package formats. For example, npm package versions
must conform to the <a href="https://semver.org/">Semantic Versioning
specification</a>. In CodeArtifact, a package version consists of the version identifier,
metadata at the package version level, and a set of assets.</p>
</li>
<li>
<p>
<b>Upstream repository</b>: One repository is <i>upstream</i> 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.</p>
</li>
<li>
<p>
<b>Asset</b>: An individual file stored in CodeArtifact associated with a package version, such as an npm
<code>.tgz</code> file or Maven POM and JAR files.</p>
</li>
</ul>
<p>CodeArtifact supports these operations:</p>
<ul>
<li>
<p>
<code>AssociateExternalConnection</code>: Adds an existing external
connection to a repository.
</p>
</li>
<li>
<p>
<code>CopyPackageVersions</code>: Copies package versions from one
repository to another repository in the same domain.</p>
</li>
<li>
<p>
<code>CreateDomain</code>: Creates a domain</p>
</li>
<li>
<p>
<code>CreateRepository</code>: Creates a CodeArtifact repository in a domain. </p>
</li>
<li>
<p>
<code>DeleteDomain</code>: Deletes a domain. You cannot delete a domain that contains
repositories. </p>
</li>
<li>
<p>
<code>DeleteDomainPermissionsPolicy</code>: Deletes the resource policy that is set on a domain.</p>
</li>
<li>
<p>
<code>DeletePackageVersions</code>: 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.</p>
</li>
<li>
<p>
<code>DeleteRepository</code>: Deletes a repository.
</p>
</li>
<li>
<p>
<code>DeleteRepositoryPermissionsPolicy</code>: Deletes the resource policy that is set on a repository.</p>
</li>
<li>
<p>
<code>DescribeDomain</code>: Returns a <code>DomainDescription</code> object that
contains information about the requested domain.</p>
</li>
<li>
<p>
<code>DescribePackageVersion</code>: Returns a <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html">PackageVersionDescription</a>
object that contains details about a package version. </p>
</li>
<li>
<p>
<code>DescribeRepository</code>: Returns a <code>RepositoryDescription</code> object
that contains detailed information about the requested repository. </p>
</li>
<li>
<p>
<code>DisposePackageVersions</code>: Disposes versions of a package. A package version
with the status <code>Disposed</code> cannot be restored because they have been
permanently removed from storage.</p>
</li>
<li>
<p>
<code>DisassociateExternalConnection</code>: Removes an existing external connection from a repository.
</p>
</li>
<li>
<p>
<code>GetAuthorizationToken</code>: 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.</p>
</li>
<li>
<p>
<code>GetDomainPermissionsPolicy</code>: Returns the policy of a resource
that is attached to the specified domain. </p>
</li>
<li>
<p>
<code>GetPackageVersionAsset</code>: Returns the contents of an asset that is in a package version. </p>
</li>
<li>
<p>
<code>GetPackageVersionReadme</code>: Gets the readme file or descriptive text for a package version.</p>
</li>
<li>
<p>
<code>GetRepositoryEndpoint</code>: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each
package format:
</p>
<ul>
<li>
<p>
<code>npm</code>
</p>
</li>
<li>
<p>
<code>pypi</code>
</p>
</li>
<li>
<p>
<code>maven</code>
</p>
</li>
</ul>
</li>
<li>
<p>
<code>GetRepositoryPermissionsPolicy</code>: Returns the resource policy that is set on a repository.
</p>
</li>
<li>
<p>
<code>ListDomains</code>: Returns a list of <code>DomainSummary</code> objects. Each
returned <code>DomainSummary</code> object contains information about a domain.</p>
</li>
<li>
<p>
<code>ListPackages</code>: Lists the packages in a repository.</p>
</li>
<li>
<p>
<code>ListPackageVersionAssets</code>: Lists the assets for a given package version.</p>
</li>
<li>
<p>
<code>ListPackageVersionDependencies</code>: Returns a list of the direct dependencies for a
package version. </p>
</li>
<li>
<p>
<code>ListPackageVersions</code>: Returns a list of package versions for a specified
package in a repository.</p>
</li>
<li>
<p>
<code>ListRepositories</code>: Returns a list of repositories owned by the AWS account that called this method.</p>
</li>
<li>
<p>
<code>ListRepositoriesInDomain</code>: Returns a list of the repositories in a domain.</p>
</li>
<li>
<p>
<code>PutDomainPermissionsPolicy</code>: Attaches a resource policy to a domain.</p>
</li>
<li>
<p>
<code>PutRepositoryPermissionsPolicy</code>: Sets the resource policy on a repository
that specifies permissions to access it. </p>
</li>
<li>
<p>
<code>UpdatePackageVersionsStatus</code>: Updates the status of one or more versions of a package.</p>
</li>
<li>
<p>
<code>UpdateRepository</code>: Updates the properties of a repository.</p>
</li>
</ul>
Inheritance
AWSService
Initializers
init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the CodeArtifact client
public init(
client: AWSClient,
region: SotoCore.Region? = nil,
partition: AWSPartition = .aws,
endpoint: String? = nil,
timeout: TimeAmount? = nil,
byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
options: AWSServiceConfig.Options = []
)
Parameters
- client: AWSClient used to process requests
- region: Region of server you want to communicate with. This will override the partition parameter.
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: CodeArtifact, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
associateExternalConnection(_:logger:on:)
public func associateExternalConnection(_ input: AssociateExternalConnectionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<AssociateExternalConnectionResult>
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.
copyPackageVersions(_:logger:on:)
public func copyPackageVersions(_ input: CopyPackageVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CopyPackageVersionsResult>
Copies package versions from one repository to another repository in the same domain.
You must specify versions
or versionRevisions
. You cannot specify both.
createDomain(_:logger:on:)
public func createDomain(_ input: CreateDomainRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDomainResult>
Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different AWS accounts. An asset is stored only once in a domain, even if it's in multiple repositories.
Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.
createRepository(_:logger:on:)
public func createRepository(_ input: CreateRepositoryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateRepositoryResult>
Creates a repository.
deleteDomain(_:logger:on:)
public func deleteDomain(_ input: DeleteDomainRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteDomainResult>
Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.
deleteDomainPermissionsPolicy(_:logger:on:)
public func deleteDomainPermissionsPolicy(_ input: DeleteDomainPermissionsPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteDomainPermissionsPolicyResult>
Deletes the resource policy set on a domain.
deletePackageVersions(_:logger:on:)
public func deletePackageVersions(_ input: DeletePackageVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeletePackageVersionsResult>
Deletes one or more versions of a package. A deleted package version cannot be restored
in your repository. If you want to remove a package version from your repository and be able
to restore it later, set its status to Archived
. Archived packages cannot be
downloaded from a repository and don't show up with list package APIs (for example,
ListackageVersions), but you can restore them using UpdatePackageVersionsStatus.
deleteRepository(_:logger:on:)
public func deleteRepository(_ input: DeleteRepositoryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteRepositoryResult>
Deletes a repository.
deleteRepositoryPermissionsPolicy(_:logger:on:)
public func deleteRepositoryPermissionsPolicy(_ input: DeleteRepositoryPermissionsPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteRepositoryPermissionsPolicyResult>
Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate.
Use DeleteRepositoryPermissionsPolicy
with caution. After a policy is deleted, AWS users, roles, and accounts lose permissions to perform
the repository actions granted by the deleted policy.
describeDomain(_:logger:on:)
public func describeDomain(_ input: DescribeDomainRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeDomainResult>
Returns a DomainDescription object that contains information about the requested domain.
describePackageVersion(_:logger:on:)
public func describePackageVersion(_ input: DescribePackageVersionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribePackageVersionResult>
Returns a PackageVersionDescription object that contains information about the requested package version.
describeRepository(_:logger:on:)
public func describeRepository(_ input: DescribeRepositoryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeRepositoryResult>
Returns a RepositoryDescription
object that contains detailed information
about the requested repository.
disassociateExternalConnection(_:logger:on:)
public func disassociateExternalConnection(_ input: DisassociateExternalConnectionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DisassociateExternalConnectionResult>
Removes an existing external connection from a repository.
disposePackageVersions(_:logger:on:)
public func disposePackageVersions(_ input: DisposePackageVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DisposePackageVersionsResult>
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.
<p>
To view all disposed package versions in a repository, use <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html">ListPackageVersions</a> and set the
<a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html#API_ListPackageVersions_RequestSyntax">status</a> parameter
to <code>Disposed</code>.
</p>
<p>
To view information about a disposed package version, use <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DescribePackageVersion.html">DescribePackageVersion</a>.
</p>
getAuthorizationToken(_:logger:on:)
public func getAuthorizationToken(_ input: GetAuthorizationTokenRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetAuthorizationTokenResult>
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
AWS CodeArtifact authentication and tokens.
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 for more information on controlling session duration.
getDomainPermissionsPolicy(_:logger:on:)
public func getDomainPermissionsPolicy(_ input: GetDomainPermissionsPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetDomainPermissionsPolicyResult>
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 in the AWS Identity and Access Management User Guide.
getPackageVersionAsset(_:logger:on:)
public func getPackageVersionAsset(_ input: GetPackageVersionAssetRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetPackageVersionAssetResult>
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.
getPackageVersionReadme(_:logger:on:)
public func getPackageVersionReadme(_ input: GetPackageVersionReadmeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetPackageVersionReadmeResult>
Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact
extracts a description from a metadata file. For example, from the
element in the
pom.xml
file of a Maven package.
The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.
getRepositoryEndpoint(_:logger:on:)
public func getRepositoryEndpoint(_ input: GetRepositoryEndpointRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetRepositoryEndpointResult>
Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
-
npm
-
pypi
-
maven
getRepositoryPermissionsPolicy(_:logger:on:)
public func getRepositoryPermissionsPolicy(_ input: GetRepositoryPermissionsPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetRepositoryPermissionsPolicyResult>
Returns the resource policy that is set on a repository.
listDomains(_:logger:on:)
public func listDomains(_ input: ListDomainsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListDomainsResult>
Returns a list of DomainSummary objects for all domains owned by the AWS account that makes
this call. Each returned DomainSummary
object contains information about a
domain.
listPackageVersionAssets(_:logger:on:)
public func listPackageVersionAssets(_ input: ListPackageVersionAssetsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListPackageVersionAssetsResult>
Returns a list of AssetSummary objects for assets in a package version.
listPackageVersionDependencies(_:logger:on:)
public func listPackageVersionDependencies(_ input: ListPackageVersionDependenciesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListPackageVersionDependenciesResult>
Returns the direct dependencies for a package version. The dependencies are returned as
PackageDependency
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.
listPackageVersions(_:logger:on:)
public func listPackageVersions(_ input: ListPackageVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListPackageVersionsResult>
Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters.
listPackages(_:logger:on:)
public func listPackages(_ input: ListPackagesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListPackagesResult>
Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
listRepositories(_:logger:on:)
public func listRepositories(_ input: ListRepositoriesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListRepositoriesResult>
Returns a list of
RepositorySummary
objects. Each RepositorySummary
contains information about a repository in the specified AWS account and that matches the input
parameters.
listRepositoriesInDomain(_:logger:on:)
public func listRepositoriesInDomain(_ input: ListRepositoriesInDomainRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListRepositoriesInDomainResult>
Returns a list of
RepositorySummary
objects. Each RepositorySummary
contains information about a repository in the specified domain and that matches the input
parameters.
listTagsForResource(_:logger:on:)
public func listTagsForResource(_ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourceResult>
Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeArtifact.
putDomainPermissionsPolicy(_:logger:on:)
public func putDomainPermissionsPolicy(_ input: PutDomainPermissionsPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutDomainPermissionsPolicyResult>
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.
putRepositoryPermissionsPolicy(_:logger:on:)
public func putRepositoryPermissionsPolicy(_ input: PutRepositoryPermissionsPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutRepositoryPermissionsPolicyResult>
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.
tagResource(_:logger:on:)
public func tagResource(_ input: TagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<TagResourceResult>
Adds or updates tags for a resource in AWS CodeArtifact.
untagResource(_:logger:on:)
public func untagResource(_ input: UntagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UntagResourceResult>
Removes tags from a resource in AWS CodeArtifact.
updatePackageVersionsStatus(_:logger:on:)
public func updatePackageVersionsStatus(_ input: UpdatePackageVersionsStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdatePackageVersionsStatusResult>
Updates the status of one or more versions of a package.
updateRepository(_:logger:on:)
public func updateRepository(_ input: UpdateRepositoryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateRepositoryResult>
Update the properties of a repository.
getPackageVersionAssetStreaming(_:logger:on:_:)
public func getPackageVersionAssetStreaming(_ input: GetPackageVersionAssetRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil, _ stream: @escaping (ByteBuffer, EventLoop)->EventLoopFuture<Void>) -> EventLoopFuture<GetPackageVersionAssetResult>
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.
listDomainsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listDomainsPaginator( _ input: ListDomainsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListDomainsRequest, ListDomainsResult>
Returns a list of DomainSummary objects for all domains owned by the AWS account that makes this call. Each returned
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onDomainSummary
object contains information about a domain.
listPackageVersionAssetsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listPackageVersionAssetsPaginator( _ input: ListPackageVersionAssetsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListPackageVersionAssetsRequest, ListPackageVersionAssetsResult>
Returns a list of AssetSummary objects for assets in a package version.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listPackageVersionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listPackageVersionsPaginator( _ input: ListPackageVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListPackageVersionsRequest, ListPackageVersionsResult>
Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listPackagesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listPackagesPaginator( _ input: ListPackagesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListPackagesRequest, ListPackagesResult>
Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listRepositoriesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listRepositoriesPaginator( _ input: ListRepositoriesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListRepositoriesRequest, ListRepositoriesResult>
Returns a list of RepositorySummary objects. Each
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onRepositorySummary
contains information about a repository in the specified AWS account and that matches the input parameters.
listRepositoriesInDomainPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listRepositoriesInDomainPaginator( _ input: ListRepositoriesInDomainRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListRepositoriesInDomainRequest, ListRepositoriesInDomainResult>
Returns a list of RepositorySummary objects. Each
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onRepositorySummary
contains information about a repository in the specified domain and that matches the input parameters.
listDomainsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listDomainsPaginator<Result>(
_ input: ListDomainsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListDomainsResult, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of DomainSummary objects for all domains owned by the AWS account that makes
this call. Each returned DomainSummary
object contains information about a
domain.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listDomainsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listDomainsPaginator(
_ input: ListDomainsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListDomainsResult, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listPackageVersionAssetsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listPackageVersionAssetsPaginator<Result>(
_ input: ListPackageVersionAssetsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListPackageVersionAssetsResult, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of AssetSummary objects for assets in a package version.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listPackageVersionAssetsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listPackageVersionAssetsPaginator(
_ input: ListPackageVersionAssetsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListPackageVersionAssetsResult, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listPackageVersionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listPackageVersionsPaginator<Result>(
_ input: ListPackageVersionsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListPackageVersionsResult, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listPackageVersionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listPackageVersionsPaginator(
_ input: ListPackageVersionsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListPackageVersionsResult, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listPackagesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listPackagesPaginator<Result>(
_ input: ListPackagesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListPackagesResult, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listPackagesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listPackagesPaginator(
_ input: ListPackagesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListPackagesResult, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listRepositoriesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listRepositoriesPaginator<Result>(
_ input: ListRepositoriesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListRepositoriesResult, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of
RepositorySummary
objects. Each RepositorySummary
contains information about a repository in the specified AWS account and that matches the input
parameters.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listRepositoriesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listRepositoriesPaginator(
_ input: ListRepositoriesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListRepositoriesResult, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listRepositoriesInDomainPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listRepositoriesInDomainPaginator<Result>(
_ input: ListRepositoriesInDomainRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListRepositoriesInDomainResult, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of
RepositorySummary
objects. Each RepositorySummary
contains information about a repository in the specified domain and that matches the input
parameters.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listRepositoriesInDomainPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listRepositoriesInDomainPaginator(
_ input: ListRepositoriesInDomainRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListRepositoriesInDomainResult, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.