Skip to content

GetComponentVersionArtifactRequest

Source code in docs_src/capo_greengrassv2/types/get_component_version_artifact_request.py
class GetComponentVersionArtifactRequest(TypedDict, closed=True):
    arn: "capo_greengrassv2.types.component_version_arn.ComponentVersionARN"
    """<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>"""
    artifact_name: "capo_greengrassv2.types.non_empty_string.NonEmptyString"
    """<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>"""
    s3_endpoint_type: NotRequired[
        "capo_greengrassv2.types.s3_endpoint_type.S3EndpointType"
    ]
    """<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>"""
    iot_endpoint_type: NotRequired[
        "capo_greengrassv2.types.iot_endpoint_type.IotEndpointType"
    ]
    """<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>"""

arn instance-attribute

The ARN of the component version. Specify the ARN of a public or a Lambda component version.

artifact_name instance-attribute

artifact_name: NonEmptyString

The name of the artifact.

You can use the GetComponent 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 greengrass:SomeArtifact.zip, the artifact name is SomeArtifact.zip.

iot_endpoint_type instance-attribute

iot_endpoint_type: NotRequired[IotEndpointType]

Determines if the Amazon S3 URL returned is a FIPS pre-signed URL endpoint. Specify fips 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 standard.

s3_endpoint_type instance-attribute

s3_endpoint_type: NotRequired[S3EndpointType]

Specifies the endpoint to use when getting Amazon S3 pre-signed URLs.

All Amazon Web Services Regions except US East (N. Virginia) use REGIONAL in all cases. In the US East (N. Virginia) Region the default is GLOBAL, but you can change it to REGIONAL with this parameter.