¡Se Herramientas de AWS para PowerShell ha lanzado la versión 5 (V5) del\$1
Para obtener información sobre los cambios más importantes y la migración de sus aplicaciones, consulte el tema [sobre migración](https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html).
[https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html](https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html)
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
# Ejemplos de DynamoDB con Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con DynamoDB.
Las *acciones* son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-DDBIndexSchema`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-DDBIndexSchema`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea un TableSchema objeto vacío y le añade una nueva definición de índice secundario local antes de escribir el TableSchema objeto en la canalización.**
```
$schema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"
$schema = New-DDBTableSchema
```
**Salida:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{LastPostDateTime} {} {LastPostIndex}
```
**Ejemplo 2: añade una nueva definición de índice secundario local al TableSchema objeto suministrado antes de volver a escribir el TableSchema objeto en la canalización. El TableSchema objeto también se puede proporcionar mediante el parámetro -Scheme.**
```
New-DDBTableSchema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"
```
**Salida:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{LastPostDateTime} {} {LastPostIndex}
```
+ Para obtener información sobre la API, consulte [Add- DDBIndex Schema](https://docs.aws.amazon.com/powershell/v5/reference) en *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `Add-DDBKeySchema`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-DDBKeySchema`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea un TableSchema objeto vacío y le añade entradas de definición de claves y atributos utilizando los datos clave especificados antes de escribir el TableSchema objeto en la canalización. El tipo de clave se declara «HASH» de forma predeterminada; utilice el KeyType parámetro - con el valor «RANGE» para declarar una clave de rango.**
```
$schema = New-DDBTableSchema
$schema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
```
**Salida:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{ForumName} {ForumName} {}
```
**Ejemplo 2: añade nuevas entradas de definición de atributos y claves al TableSchema objeto suministrado antes de escribir el TableSchema objeto en la canalización. El tipo de clave se declara «HASH» de forma predeterminada; utilice el KeyType parámetro - con el valor «RANGE» para declarar una clave de rango. El TableSchema objeto también se puede proporcionar mediante el parámetro -Scheme.**
```
New-DDBTableSchema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
```
**Salida:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{ForumName} {ForumName} {}
```
+ Para obtener información sobre la API, consulte [Add- DDBKey Schema](https://docs.aws.amazon.com/powershell/v5/reference) en *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `ConvertFrom-DDBItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `ConvertFrom-DDBItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: ConvertFrom - DDBItem se usa para convertir el resultado de Get-DDBItem una tabla hash de AttributeValues DynamoDB en una tabla hash de tipos comunes como string y double.**
```
@{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Get-DDBItem -TableName 'Music' -Key $key | ConvertFrom-DDBItem
```
**Salida:**
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
```
+ Para obtener más información sobre la API, consulte [ConvertFrom- DDBItem](https://docs.aws.amazon.com/powershell/v5/reference) en *Herramientas de AWS para PowerShell Cmdlet* Reference (V5).
### `ConvertTo-DDBItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `ConvertTo-DDBItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Ejemplo de conversión de una tabla hash en un diccionario de valores de atributos de DynamoDB.**
```
@{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Key Value
--- -----
SongTitle Amazon.DynamoDBv2.Model.AttributeValue
Artist Amazon.DynamoDBv2.Model.AttributeValue
```
**Ejemplo 2: Ejemplo de conversión de una tabla hash en un diccionario de valores de atributos de DynamoDB.**
```
@{
MyMap = @{
MyString = 'my string'
}
MyStringSet = [System.Collections.Generic.HashSet[String]]@('my', 'string')
MyNumericSet = [System.Collections.Generic.HashSet[Int]]@(1, 2, 3)
MyBinarySet = [System.Collections.Generic.HashSet[System.IO.MemoryStream]]@(
([IO.MemoryStream]::new([Text.Encoding]::UTF8.GetBytes('my'))),
([IO.MemoryStream]::new([Text.Encoding]::UTF8.GetBytes('string')))
)
MyList1 = @('my', 'string')
MyList2 = [System.Collections.Generic.List[Int]]@(1, 2)
MyList3 = [System.Collections.ArrayList]@('one', 2, $true)
} | ConvertTo-DDBItem
```
**Salida:**
```
Key Value
--- -----
MyStringSet Amazon.DynamoDBv2.Model.AttributeValue
MyList1 Amazon.DynamoDBv2.Model.AttributeValue
MyNumericSet Amazon.DynamoDBv2.Model.AttributeValue
MyList2 Amazon.DynamoDBv2.Model.AttributeValue
MyBinarySet Amazon.DynamoDBv2.Model.AttributeValue
MyMap Amazon.DynamoDBv2.Model.AttributeValue
MyList3 Amazon.DynamoDBv2.Model.AttributeValue
```
+ Para obtener más información sobre la API, consulte [ConvertTo- DDBItem](https://docs.aws.amazon.com/powershell/v5/reference) en *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `Get-DDBBatchItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DDBBatchItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Obtiene el elemento SongTitle «Somewhere Down The Road» de las tablas «Music» y «Songs» de DynamoDB.**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
$keysAndAttributes = New-Object Amazon.DynamoDBv2.Model.KeysAndAttributes
$list = New-Object 'System.Collections.Generic.List[System.Collections.Generic.Dictionary[String, Amazon.DynamoDBv2.Model.AttributeValue]]'
$list.Add($key)
$keysAndAttributes.Keys = $list
$requestItem = @{
'Music' = [Amazon.DynamoDBv2.Model.KeysAndAttributes]$keysAndAttributes
'Songs' = [Amazon.DynamoDBv2.Model.KeysAndAttributes]$keysAndAttributes
}
$batchItems = Get-DDBBatchItem -RequestItem $requestItem
$batchItems.GetEnumerator() | ForEach-Object {$PSItem.Value} | ConvertFrom-DDBItem
```
**Salida:**
```
Name Value
---- -----
Artist No One You Know
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
CriticRating 10
Genre Country
Price 1.94
Artist No One You Know
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
CriticRating 10
Genre Country
Price 1.94
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [BatchGetItem](https://docs.aws.amazon.com/powershell/v5/reference)*Reference (V5).
### `Get-DDBItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DDBItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve el elemento de DynamoDB con la clave de partición y la SongTitle clave de clasificación Artist.**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Get-DDBItem -TableName 'Music' -Key $key | ConvertFrom-DDBItem
```
**Salida:**
```
Name Value
---- -----
Genre Country
SongTitle Somewhere Down The Road
Price 1.94
Artist No One You Know
CriticRating 9
AlbumTitle Somewhat Famous
```
+ Para obtener más información sobre la API, consulte [GetItem Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-DDBTable`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DDBTable`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve información detallada de la tabla especificada.**
```
Get-DDBTable -TableName "myTable"
```
+ Para obtener más información sobre la API, consulte [DescribeTable](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DDBTableList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DDBTableList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve los detalles de todas las tablas y se itera automáticamente hasta que el servicio indique que no existen más tablas.**
```
Get-DDBTableList
```
+ Para obtener más información sobre la API, consulte [ListTables](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Invoke-DDBQuery`
En el siguiente ejemplo de código, se muestra cómo utilizar `Invoke-DDBQuery`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Invoca una consulta que devuelve elementos de DynamoDB con el identificador y el artista especificados. SongTitle **
```
$invokeDDBQuery = @{
TableName = 'Music'
KeyConditionExpression = ' SongTitle = :SongTitle and Artist = :Artist'
ExpressionAttributeValues = @{
':SongTitle' = 'Somewhere Down The Road'
':Artist' = 'No One You Know'
} | ConvertTo-DDBItem
}
Invoke-DDBQuery @invokeDDBQuery | ConvertFrom-DDBItem
```
**Salida:**
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
```
+ Para obtener detalles de la API, consulte [Query](https://docs.aws.amazon.com/powershell/v5/reference) en la *Referencia de cmdlets de Herramientas de AWS para PowerShell (V5)*.
### `Invoke-DDBScan`
En el siguiente ejemplo de código, se muestra cómo utilizar `Invoke-DDBScan`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve todos los elementos de la tabla Music.**
```
Invoke-DDBScan -TableName 'Music' | ConvertFrom-DDBItem
```
**Salida:**
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
Genre Country
Artist No One You Know
Price 1.98
CriticRating 8.4
SongTitle My Dog Spot
AlbumTitle Hey Now
```
**Ejemplo 2: Devuelve los elementos de la tabla Música con un valor CriticRating mayor o igual a nueve.**
```
$scanFilter = @{
CriticRating = [Amazon.DynamoDBv2.Model.Condition]@{
AttributeValueList = @(@{N = '9'})
ComparisonOperator = 'GE'
}
}
Invoke-DDBScan -TableName 'Music' -ScanFilter $scanFilter | ConvertFrom-DDBItem
```
**Salida:**
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
```
+ Para obtener detalles de la API, consulte [Scan](https://docs.aws.amazon.com/powershell/v5/reference) en la *Referencia de cmdlets de Herramientas de AWS para PowerShell (V5)*.
### `New-DDBTable`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DDBTable`.
**Herramientas para la PowerShell versión 5**
**Ejemplo 1: En este ejemplo se crea una tabla denominada Thread que tiene una clave principal compuesta por «ForumName» (tipo clave hash) y «Subject» (rango de tipos de clave). El esquema utilizado para construir la tabla se puede canalizar hacia cada cmdlet tal como se muestra o se especifica con el parámetro -Schema.**
```
$schema = New-DDBTableSchema
$schema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
$schema | Add-DDBKeySchema -KeyName "Subject" -KeyType RANGE -KeyDataType "S"
$schema | New-DDBTable -TableName "Thread" -ReadCapacity 10 -WriteCapacity 5
```
**Salida:**
```
AttributeDefinitions : {ForumName, Subject}
TableName : Thread
KeySchema : {ForumName, Subject}
TableStatus : CREATING
CreationDateTime : 10/28/2013 4:39:49 PM
ProvisionedThroughput : Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription
TableSizeBytes : 0
ItemCount : 0
LocalSecondaryIndexes : {}
```
**Ejemplo 2: en este ejemplo se crea una tabla denominada Thread que tiene una clave principal compuesta por «ForumName» (tipo hash de clave) y «Asunto» (rango de tipos de clave). También se define un índice secundario local. La clave del índice secundario local se establecerá automáticamente a partir de la clave hash principal de la tabla (ForumName). El esquema utilizado para construir la tabla se puede canalizar hacia cada cmdlet tal como se muestra o se especifica con el parámetro -Schema.**
```
$schema = New-DDBTableSchema
$schema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
$schema | Add-DDBKeySchema -KeyName "Subject" -KeyDataType "S"
$schema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"
$schema | New-DDBTable -TableName "Thread" -ReadCapacity 10 -WriteCapacity 5
```
**Salida:**
```
AttributeDefinitions : {ForumName, LastPostDateTime, Subject}
TableName : Thread
KeySchema : {ForumName, Subject}
TableStatus : CREATING
CreationDateTime : 10/28/2013 4:39:49 PM
ProvisionedThroughput : Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription
TableSizeBytes : 0
ItemCount : 0
LocalSecondaryIndexes : {LastPostIndex}
```
**Ejemplo 3: En este ejemplo se muestra cómo utilizar una canalización única para crear una tabla denominada Thread que tenga una clave principal compuesta por «ForumName» (hash de tipo de clave) y «Asunto» (rango de tipos de clave) y un índice secundario local. Los comandos Add- DDBKey DDBIndex Schema y Add-Schema crean un TableSchema objeto nuevo si no lo proporcionan la canalización o el parámetro -Scheme.**
```
New-DDBTableSchema |
Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S" |
Add-DDBKeySchema -KeyName "Subject" -KeyDataType "S" |
Add-DDBIndexSchema -IndexName "LastPostIndex" `
-RangeKeyName "LastPostDateTime" `
-RangeKeyDataType "S" `
-ProjectionType "keys_only" |
New-DDBTable -TableName "Thread" -ReadCapacity 10 -WriteCapacity 5
```
**Salida:**
```
AttributeDefinitions : {ForumName, LastPostDateTime, Subject}
TableName : Thread
KeySchema : {ForumName, Subject}
TableStatus : CREATING
CreationDateTime : 10/28/2013 4:39:49 PM
ProvisionedThroughput : Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription
TableSizeBytes : 0
ItemCount : 0
LocalSecondaryIndexes : {LastPostIndex}
```
+ Para obtener más información sobre la API, consulte [CreateTable Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `New-DDBTableSchema`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DDBTableSchema`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea un TableSchema objeto vacío listo para aceptar definiciones de claves e índices para su uso en la creación de una nueva tabla de Amazon DynamoDB. El objeto devuelto puede canalizarse a los DDBTable cmdlets Add- DDBKey Schema, Add- DDBIndex Schema y New- o pasarse a ellos mediante el parámetro -Scheme de cada cmdlet.**
```
New-DDBTableSchema
```
**Salida:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{} {} {}
```
+ *Para obtener información sobre la API, consulte [New- DDBTable Schema](https://docs.aws.amazon.com/powershell/v5/reference) in Herramientas de AWS para PowerShell Cmdlet Reference (V5).*
### `Remove-DDBItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-DDBItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: elimina el elemento DynamoDB que coincide con la clave proporcionada.**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Remove-DDBItem -TableName 'Music' -Key $key -Confirm:$false
```
+ Para obtener más información sobre la API, consulte [DeleteItem](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-DDBTable`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-DDBTable`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: elimina la tabla especificada. Se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-DDBTable -TableName "myTable"
```
**Ejemplo 2: elimina la tabla especificada. No se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-DDBTable -TableName "myTable" -Force
```
+ Para obtener más información sobre la API, consulte [DeleteTable](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-DDBBatchItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-DDBBatchItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea un nuevo elemento o sustituye un elemento existente por uno nuevo en las tablas Music y Songs de DynamoDB.**
```
$item = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
AlbumTitle = 'Somewhat Famous'
Price = 1.94
Genre = 'Country'
CriticRating = 10.0
} | ConvertTo-DDBItem
$writeRequest = New-Object Amazon.DynamoDBv2.Model.WriteRequest
$writeRequest.PutRequest = [Amazon.DynamoDBv2.Model.PutRequest]$item
$requestItem = @{
'Music' = [Amazon.DynamoDBv2.Model.WriteRequest]($writeRequest)
'Songs' = [Amazon.DynamoDBv2.Model.WriteRequest]($writeRequest)
}
Set-DDBBatchItem -RequestItem $requestItem
```
+ Para obtener más información sobre la API, consulte [BatchWriteItem](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-DDBItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-DDBItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea un nuevo elemento o sustituye un elemento existente por uno nuevo.**
```
$item = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
AlbumTitle = 'Somewhat Famous'
Price = 1.94
Genre = 'Country'
CriticRating = 9.0
} | ConvertTo-DDBItem
Set-DDBItem -TableName 'Music' -Item $item
```
+ Para obtener más información sobre la API, consulte [PutItem](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-DDBItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-DDBItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Establece el atributo de género en «Rap» en el elemento de DynamoDB con la clave de partición y la SongTitle clave de clasificación Artist.**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
$updateDdbItem = @{
TableName = 'Music'
Key = $key
UpdateExpression = 'set Genre = :val1'
ExpressionAttributeValue = (@{
':val1' = ([Amazon.DynamoDBv2.Model.AttributeValue]'Rap')
})
}
Update-DDBItem @updateDdbItem
```
**Salida:**
```
Name Value
---- -----
Genre Rap
```
+ Para obtener más información sobre la API, consulte [UpdateItem Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Update-DDBTable`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-DDBTable`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: actualiza el rendimiento aprovisionado de la tabla en cuestión.**
```
Update-DDBTable -TableName "myTable" -ReadCapacity 10 -WriteCapacity 5
```
+ Para obtener más información sobre la API, consulte [UpdateTable](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).