WorkSpaces contoh menggunakan AWS CLI - AWS SDKContoh Kode
Tindakan

Ada lebih banyak AWS SDK contoh yang tersedia di GitHub repo SDKContoh AWS Dokumen.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

WorkSpaces contoh menggunakan AWS CLI

Contoh kode berikut menunjukkan cara melakukan tindakan dan menerapkan skenario umum dengan menggunakan AWS Command Line Interface with WorkSpaces.

Tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Sementara tindakan menunjukkan cara memanggil fungsi layanan individual, Anda dapat melihat tindakan dalam konteks dalam skenario terkait.

Setiap contoh menyertakan tautan ke kode sumber lengkap, di mana Anda dapat menemukan instruksi tentang cara mengatur dan menjalankan kode dalam konteks.

Tindakan

Contoh kode berikut menunjukkan cara menggunakancreate-tags.

AWS CLI

Untuk menambahkan tag ke WorkSpace

create-tagsContoh berikut menambahkan tag yang ditentukan ke yang ditentukan WorkSpace.

aws workspaces create-tags \
    --resource-id ws-dk1xzr417 \
    --tags Key=Department,Value=Finance

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menandai WorkSpaces sumber daya di Panduan WorkSpaces Administrasi Amazon.

  • Untuk API detailnya, lihat CreateTagsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakancreate-workspaces.

AWS CLI

Contoh 1: Untuk membuat AlwaysOn WorkSpace

create-workspacesContoh berikut menciptakan AlwaysOn WorkSpace untuk pengguna tertentu, menggunakan direktori tertentu dan bundel.

aws workspaces create-workspaces \
    --workspaces DirectoryId=d-926722edaf,UserName=Mateo,BundleId=wsb-0zsvgp8fc

Output:

{
    "FailedRequests": [],
    "PendingRequests": [
        {
            "WorkspaceId": "ws-kcqms853t",
            "DirectoryId": "d-926722edaf",
            "UserName": "Mateo",
            "State": "PENDING",
            "BundleId": "wsb-0zsvgp8fc"
        }
    ]
}

Contoh 2: Untuk membuat AutoStop WorkSpace

create-workspacesContoh berikut menciptakan AutoStop WorkSpace untuk pengguna tertentu, menggunakan direktori tertentu dan bundel.

aws workspaces create-workspaces \
    --workspaces DirectoryId=d-926722edaf,UserName=Mary,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=AUTO_STOP}

Output:

{
    "FailedRequests": [],
    "PendingRequests": [
        {
            "WorkspaceId": "ws-dk1xzr417",
            "DirectoryId": "d-926722edaf",
            "UserName": "Mary",
            "State": "PENDING",
            "BundleId": "wsb-0zsvgp8fc"
        }
    ]
}

Contoh 3: Untuk membuat user-decoupled WorkSpace

create-workspacesContoh berikut membuat user-decoupled WorkSpace dengan menyetel nama pengguna ke[UNDEFINED], dan menentukan nama, ID direktori, dan WorkSpace ID bundel.

aws workspaces create-workspaces \
    --workspaces DirectoryId=d-926722edaf,UserName='"[UNDEFINED]"',WorkspaceName=MaryWorkspace1,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=ALWAYS_ON}

Output:

{
    "FailedRequests": [],
    "PendingRequests": [
        {
            "WorkspaceId": "ws-abcd1234",
            "DirectoryId": "d-926722edaf",
            "UserName": "[UNDEFINED]",
            "State": "PENDING",
            "BundleId": "wsb-0zsvgp8fc",
            "WorkspaceName": "MaryWorkspace1"
        }
    ]
}

Untuk informasi selengkapnya, lihat Meluncurkan desktop virtual di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakandelete-tags.

AWS CLI

Untuk menghapus tag dari WorkSpace

delete-tagsContoh berikut menghapus tag yang ditentukan dari yang ditentukan WorkSpace.

aws workspaces delete-tags \
    --resource-id ws-dk1xzr417 \
    --tag-keys Department

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menandai WorkSpaces sumber daya di Panduan WorkSpaces Administrasi Amazon.

  • Untuk API detailnya, lihat DeleteTagsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanderegister-workspace-directory.

AWS CLI

Untuk membatalkan pendaftaran direktori

deregister-workspace-directoryContoh berikut deregisters direktori yang ditentukan.

aws workspaces deregister-workspace-directory \
    --directory-id d-926722edaf

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mendaftarkan direktori dengan WorkSpaces di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakandescribe-tags.

AWS CLI

Untuk mendeskripsikan tag untuk a WorkSpace

describe-tagsContoh berikut menjelaskan tag untuk yang ditentukan WorkSpace.

aws workspaces describe-tags \
    --resource-id ws-dk1xzr417

Output:

{
    "TagList": [
        {
            "Key": "Department",
            "Value": "Finance"
        }
    ]
}

Untuk informasi selengkapnya, lihat Menandai WorkSpaces sumber daya di Panduan WorkSpaces Administrasi Amazon.

  • Untuk API detailnya, lihat DescribeTagsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-workspace-bundles.

AWS CLI

Untuk membuat daftar bundel yang disediakan oleh Amazon

describe-workspace-bundlesContoh berikut mencantumkan nama dan bundel IDs yang disediakan oleh Amazon, dalam format tabel dan diurutkan berdasarkan nama.

aws workspaces describe-workspace-bundles \
    --owner AMAZON \
    --query "Bundles[*].[Name, BundleId]"

Output:

[
    [
        "Standard with Amazon Linux 2",
        "wsb-clj85qzj1"
    ],
    [
        "Performance with Windows 10 (Server 2016 based)",
        "wsb-gm4d5tx2v"
    ],
    [
        "PowerPro with Windows 7",
        "wsb-1pzkp0bx4"
    ],
    [
        "Power with Amazon Linux 2",
        "wsb-2bs6k5lgn"
    ],
    [
        "Graphics with Windows 10 (Server 2019 based)",
        "wsb-03gyjnfyy"
    ],
    ...
]

Untuk informasi selengkapnya, lihat WorkSpaces bundel dan gambar di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakandescribe-workspace-directories.

AWS CLI

Untuk mendeskripsikan direktori terdaftar

describe-workspace-directoriesContoh berikut menjelaskan direktori terdaftar yang ditentukan.

aws workspaces describe-workspace-directories \
    --directory-ids d-926722edaf

Output:

{
    "Directories": [
        {
            "DirectoryId": "d-926722edaf",
            "Alias": "d-926722edaf",
            "DirectoryName": "example.com",
            "RegistrationCode": "WSpdx+9RJ8JT",
            "SubnetIds": [
                "subnet-9d19c4c6",
                "subnet-500d5819"
            ],
            "DnsIpAddresses": [
                "172.16.1.140",
                "172.16.0.30"
            ],
            "CustomerUserName": "Administrator",
            "IamRoleId": "arn:aws:iam::123456789012:role/workspaces_DefaultRole",
            "DirectoryType": "SIMPLE_AD",
            "WorkspaceSecurityGroupId": "sg-0d89e927e5645d7c5",
            "State": "REGISTERED",
            "WorkspaceCreationProperties": {
                "EnableWorkDocs": false,
                "EnableInternetAccess": false,
                "UserEnabledAsLocalAdministrator": true,
                "EnableMaintenanceMode": true
            },
            "WorkspaceAccessProperties": {
                "DeviceTypeWindows": "ALLOW",
                "DeviceTypeOsx": "ALLOW",
                "DeviceTypeWeb": "DENY",
                "DeviceTypeIos": "ALLOW",
                "DeviceTypeAndroid": "ALLOW",
                "DeviceTypeChromeOs": "ALLOW",
                "DeviceTypeZeroClient": "ALLOW",
                "DeviceTypeLinux": "DENY"
            },
            "Tenancy": "SHARED",
            "SelfservicePermissions": {
                "RestartWorkspace": "ENABLED",
                "IncreaseVolumeSize": "DISABLED",
                "ChangeComputeType": "DISABLED",
                "SwitchRunningMode": "DISABLED",
                "RebuildWorkspace": "DISABLED"
            }
        }
    ]
}

Untuk informasi selengkapnya, lihat Mengelola direktori WorkSpaces di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakandescribe-workspaces-connection-status.

AWS CLI

Untuk menggambarkan status koneksi dari WorkSpace

describe-workspaces-connection-statusContoh berikut menjelaskan status koneksi yang ditentukan WorkSpace.

aws workspaces describe-workspaces-connection-status \
    --workspace-ids ws-dk1xzr417

Output:

{
    "WorkspacesConnectionStatus": [
        {
            "WorkspaceId": "ws-dk1xzr417",
            "ConnectionState": "CONNECTED",
            "ConnectionStateCheckTimestamp": 1662526214.744
        }
    ]
}

Untuk informasi selengkapnya, lihat Mengelola Anda WorkSpaces di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakandescribe-workspaces.

AWS CLI

Untuk menggambarkan WorkSpace

describe-workspacesContoh berikut menjelaskan yang ditentukan WorkSpace.

aws workspaces describe-workspaces \
    --workspace-ids ws-dk1xzr417

Output:

{
    "Workspaces": [
        {
            "WorkspaceId": "ws-dk1xzr417",
            "DirectoryId": "d-926722edaf",
            "UserName": "Mary",
            "IpAddress": "172.16.0.175",
            "State": "STOPPED",
            "BundleId": "wsb-0zsvgp8fc",
            "SubnetId": "subnet-500d5819",
            "ComputerName": "WSAMZN-RBSLTTD9",
            "WorkspaceProperties": {
                "RunningMode": "AUTO_STOP",
                "RunningModeAutoStopTimeoutInMinutes": 60,
                "RootVolumeSizeGib": 80,
                "UserVolumeSizeGib": 10,
                "ComputeTypeName": "VALUE"
            },
            "ModificationStates": []
        }
    ]
}

Untuk informasi selengkapnya, lihat Mengelola Anda WorkSpaces di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakanmigrate-workspace.

AWS CLI

Untuk memigrasikan a WorkSpace

migrate-workspaceContoh berikut memigrasikan yang ditentukan WorkSpace ke bundel yang ditentukan.

aws workspaces migrate-workspace \
    --source-workspace-id ws-dk1xzr417 \
    --bundle-id wsb-j4dky1gs4

Output:

{
    "SourceWorkspaceId": "ws-dk1xzr417",
    "TargetWorkspaceId": "ws-x5h1lbkp5"
}

Untuk informasi selengkapnya, lihat Memigrasi a WorkSpace di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakanmodify-workspace-creation-properties.

AWS CLI

Untuk memodifikasi properti WorkSpace penciptaan direktori

modify-workspace-creation-propertiesContoh berikut memungkinkan EnableInternetAccess properti untuk direktori tertentu. Ini memungkinkan penetapan otomatis alamat IP publik untuk yang WorkSpaces dibuat untuk direktori.

aws workspaces modify-workspace-creation-properties \
    --resource-id d-926722edaf \
    --workspace-creation-properties EnableInternetAccess=true

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Perbarui detail direktori untuk Anda WorkSpaces di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakanmodify-workspace-properties.

AWS CLI

Untuk memodifikasi mode berjalan WorkSpace

modify-workspace-propertiesContoh berikut menetapkan mode berjalan dari yang ditentukan WorkSpace untukAUTO_STOP.

aws workspaces modify-workspace-properties \
    --workspace-id ws-dk1xzr417 \
    --workspace-properties RunningMode=AUTO_STOP

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Memodifikasi WorkSpace di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakanmodify-workspace-state.

AWS CLI

Untuk memodifikasi keadaan WorkSpace

modify-workspace-stateContoh berikut menetapkan keadaan yang ditentukan WorkSpace untukADMIN_MAINTENANCE.

aws workspaces modify-workspace-state \
    --workspace-id ws-dk1xzr417 \
    --workspace-state ADMIN_MAINTENANCE

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat WorkSpace pemeliharaan di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakanreboot-workspaces.

AWS CLI

Untuk me-reboot a WorkSpace

reboot-workspacesContoh berikut reboot yang ditentukan WorkSpace.

aws workspaces reboot-workspaces \
    --reboot-workspace-requests ws-dk1xzr417

Output:

{
    "FailedRequests": []
}

Untuk informasi selengkapnya, lihat Reboot a WorkSpace di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakanrebuild-workspaces.

AWS CLI

Untuk membangun kembali WorkSpace

rebuild-workspacesContoh berikut membangun kembali yang ditentukan. WorkSpace

aws workspaces rebuild-workspaces \
    --rebuild-workspace-requests ws-dk1xzr417

Output:

{
    "FailedRequests": []
}

Untuk informasi selengkapnya, lihat Membangun kembali WorkSpace di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakanregister-workspace-directory.

AWS CLI

Untuk mendaftarkan direktori

register-workspace-directoryContoh berikut mendaftarkan direktori yang ditentukan untuk digunakan dengan Amazon WorkSpaces.

aws workspaces register-workspace-directory \
    --directory-id d-926722edaf \
    --no-enable-work-docs

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mendaftarkan direktori dengan WorkSpaces di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakanrestore-workspace.

AWS CLI

Untuk mengembalikan WorkSpace

restore-workspaceContoh berikut mengembalikan yang ditentukan WorkSpace.

aws workspaces restore-workspace \
    --workspace-id ws-dk1xzr417

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Memulihkan a WorkSpace di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakanstart-workspaces.

AWS CLI

Untuk memulai sebuah AutoStop WorkSpace

start-workspacesContoh berikut memulai yang ditentukan WorkSpace. WorkSpace Harus memiliki mode berjalanAutoStop.

aws workspaces start-workspaces \
    --start-workspace-requests WorkspaceId=ws-dk1xzr417

Output:

{
    "FailedRequests": []
}

Untuk informasi selengkapnya, lihat Berhenti dan memulai AutoStop WorkSpace di Panduan WorkSpaces Administrasi Amazon.

Contoh kode berikut menunjukkan cara menggunakanstop-workspaces.

AWS CLI

Untuk menghentikan sebuah AutoStop WorkSpace

stop-workspacesContoh berikut menghentikan yang ditentukan WorkSpace. WorkSpace Harus memiliki mode berjalanAutoStop.

aws workspaces stop-workspaces \
    --stop-workspace-requests WorkspaceId=ws-dk1xzr417

Output:

{
    "FailedRequests": []
}

Untuk informasi selengkapnya, lihat Berhenti dan memulai AutoStop WorkSpace di Panduan WorkSpaces Administrasi Amazon.

  • Untuk API detailnya, lihat StopWorkspacesdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanterminate-workspaces.

AWS CLI

Untuk mengakhiri WorkSpace

terminate-workspacesContoh berikut mengakhiri ruang kerja yang ditentukan.

aws workspaces terminate-workspaces \
    --terminate-workspace-requests ws-dk1xzr417

Output:

{
    "FailedRequests": []
}

Untuk informasi selengkapnya, lihat Menghapus a WorkSpace di Panduan WorkSpaces Administrasi Amazon.