SageMaker / Client / create_device_fleet

create_device_fleet#

SageMaker.Client.create_device_fleet(**kwargs)#

Creates a device fleet.

See also: AWS API Documentation

Request Syntax

response = client.create_device_fleet(
    DeviceFleetName='string',
    RoleArn='string',
    Description='string',
    OutputConfig={
        'S3OutputLocation': 'string',
        'KmsKeyId': 'string',
        'PresetDeploymentType': 'GreengrassV2Component',
        'PresetDeploymentConfig': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    EnableIotRoleAlias=True|False
)
Parameters:

  • DeviceFleetName (string) –

    [REQUIRED]

    The name of the fleet that the device belongs to.

  • RoleArn (string) – The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

  • Description (string) – A description of the fleet.

  • OutputConfig (dict) –

    [REQUIRED]

    The output configuration for storing sample data collected by the fleet.

    • S3OutputLocation (string) – [REQUIRED]

      The Amazon Simple Storage (S3) bucker URI.

    • KmsKeyId (string) –

      The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don’t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role’s account.

    • PresetDeploymentType (string) –

      The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

    • PresetDeploymentConfig (string) –

      The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

      • ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of “SagemakerEdgeManager” and the name of your SageMaker Edge Manager packaging job.

      • ComponentDescription (optional) - Description of the component.

      • ComponentVersion (optional) - The version of the component.

      Note

      Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a* major.minor.patch* number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.

      • PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.

      • PlatformArchitecture (optional) - The processor architecture for the platform. Supported architectures Windows include: Windows32_x86, Windows64_x64. Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

  • Tags (list) –

    Creates tags for the specified fleet.

    • (dict) –

      A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

      You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

      For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

      • Key (string) – [REQUIRED]

        The tag key. Tag keys must be unique per resource.

      • Value (string) – [REQUIRED]

        The tag value.

  • EnableIotRoleAlias (boolean) –

    Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: “SageMakerEdge-{DeviceFleetName}”.

    For example, if your device fleet is called “demo-fleet”, the name of the role alias will be “SageMakerEdge-demo-fleet”.

Returns:

None

Exceptions

  • SageMaker.Client.exceptions.ResourceInUse

  • SageMaker.Client.exceptions.ResourceLimitExceeded