aws-sdk-greengrassv2 1.112.0

AWS SDK for AWS IoT Greengrass V2
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetComponentVersionArtifact`](crate::operation::get_component_version_artifact::builders::GetComponentVersionArtifactFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`arn(impl Into<String>)`](crate::operation::get_component_version_artifact::builders::GetComponentVersionArtifactFluentBuilder::arn) / [`set_arn(Option<String>)`](crate::operation::get_component_version_artifact::builders::GetComponentVersionArtifactFluentBuilder::set_arn):<br>required: **true**<br><p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version. Specify the ARN of a public or a Lambda component version.</p><br>
    ///   - [`artifact_name(impl Into<String>)`](crate::operation::get_component_version_artifact::builders::GetComponentVersionArtifactFluentBuilder::artifact_name) / [`set_artifact_name(Option<String>)`](crate::operation::get_component_version_artifact::builders::GetComponentVersionArtifactFluentBuilder::set_artifact_name):<br>required: **true**<br><p>The name of the artifact.</p> <p>You can use the <a href="https://docs.aws.amazon.com/greengrass/v2/APIReference/API_GetComponent.html">GetComponent</a> operation to download the component recipe, which includes the URI of the artifact. The artifact name is the section of the URI after the scheme. For example, in the artifact URI <code>greengrass:SomeArtifact.zip</code>, the artifact name is <code>SomeArtifact.zip</code>.</p><br>
    ///   - [`s3_endpoint_type(S3EndpointType)`](crate::operation::get_component_version_artifact::builders::GetComponentVersionArtifactFluentBuilder::s3_endpoint_type) / [`set_s3_endpoint_type(Option<S3EndpointType>)`](crate::operation::get_component_version_artifact::builders::GetComponentVersionArtifactFluentBuilder::set_s3_endpoint_type):<br>required: **false**<br><p>Specifies the endpoint to use when getting Amazon S3 pre-signed URLs.</p> <p>All Amazon Web Services Regions except US East (N. Virginia) use <code>REGIONAL</code> in all cases. In the US East (N. Virginia) Region the default is <code>GLOBAL</code>, but you can change it to <code>REGIONAL</code> with this parameter.</p><br>
    ///   - [`iot_endpoint_type(IotEndpointType)`](crate::operation::get_component_version_artifact::builders::GetComponentVersionArtifactFluentBuilder::iot_endpoint_type) / [`set_iot_endpoint_type(Option<IotEndpointType>)`](crate::operation::get_component_version_artifact::builders::GetComponentVersionArtifactFluentBuilder::set_iot_endpoint_type):<br>required: **false**<br><p>Determines if the Amazon S3 URL returned is a FIPS pre-signed URL endpoint. Specify <code>fips</code> if you want the returned Amazon S3 pre-signed URL to point to an Amazon S3 FIPS endpoint. If you don't specify a value, the default is <code>standard</code>.</p><br>
    /// - On success, responds with [`GetComponentVersionArtifactOutput`](crate::operation::get_component_version_artifact::GetComponentVersionArtifactOutput) with field(s):
    ///   - [`pre_signed_url(String)`](crate::operation::get_component_version_artifact::GetComponentVersionArtifactOutput::pre_signed_url): <p>The URL of the artifact.</p>
    /// - On failure, responds with [`SdkError<GetComponentVersionArtifactError>`](crate::operation::get_component_version_artifact::GetComponentVersionArtifactError)
    pub fn get_component_version_artifact(
        &self,
    ) -> crate::operation::get_component_version_artifact::builders::GetComponentVersionArtifactFluentBuilder {
        crate::operation::get_component_version_artifact::builders::GetComponentVersionArtifactFluentBuilder::new(self.handle.clone())
    }
}