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.
Detección y alias de cmdlet
En esta sección se muestra cómo enumerar los servicios compatibles con las AWS Tools for PowerShell, cómo mostrar el conjunto de cmdlets proporcionados por las AWS Tools for PowerShell que respaldan dichos servicios y cómo encontrar nombres de cmdlet alternativos (también denominados alias) para obtener acceso a dichos servicios.
Detección de cmdlets
Todas las operaciones de servicio (o API) de AWS se documentan en la Guía de referencia de la API de cada servicio. Por ejemplo, consulte la Referencia de la API de IAM. En la mayoría de los casos, existe una correspondencia uno a uno entre una API de servicio de AWS y un cmdlet de PowerShell de AWS. Para obtener el nombre de cmdlet correspondiente a la API de un servicio de AWS, ejecute el cmdlet de AWS Get-AWSCmdletName junto con el parámetro -ApiOperation y el nombre de la API del servicio de AWS. Por ejemplo, para obtener todos los nombres posibles de cmdlet basados en cualquier API DescribeInstances del servicio de AWS disponible, ejecute el siguiente comando:
PS >Get-AWSCmdletName -ApiOperation DescribeInstancesCmdletName ServiceOperation ServiceName CmdletNounPrefix ---------- ---------------- ----------- ---------------- Get-EC2Instance DescribeInstances Amazon Elastic Compute Cloud EC2 Get-GMLInstance DescribeInstances Amazon GameLift Service GML
El parámetro -ApiOperation es el parámetro predeterminado, por lo que puede omitir el nombre del parámetro. El siguiente ejemplo es equivalente al anterior:
PS >Get-AWSCmdletName DescribeInstances
Si conoce los nombres de la API y el servicio que desea utilizar, puede incluir el parámetro -Service junto con el prefijo del nombre de cmdlet o parte del nombre del servicio de AWS. Por ejemplo, el prefijo del nombre de cmdlet para Amazon EC2 es EC2. Para obtener el nombre de cmdlet correspondiente a la API DescribeInstances en el servicio de Amazon EC2, ejecute uno de los siguientes comandos. Todos ellos dan como resultado la misma salida:
PS >Get-AWSCmdletName -ApiOperation DescribeInstances -Service EC2PS >Get-AWSCmdletName -ApiOperation DescribeInstances -Service ComputePS >Get-AWSCmdletName -ApiOperation DescribeInstances -Service "Compute Cloud"CmdletName ServiceOperation ServiceName CmdletNounPrefix ---------- ---------------- ----------- ---------------- Get-EC2Instance DescribeInstances Amazon Elastic Compute Cloud EC2
Los valores de los parámetros en estos comandos no distinguen entre mayúsculas y minúsculas.
Si no conoce el nombre de la API del servicio de AWS o el servicio de AWS que desea usar, puede utilizar el parámetro -ApiOperation junto con el patrón de correspondencia y el parámetro -MatchWithRegex. Por ejemplo, para obtener todos los nombres de cmdlet disponibles que contienen SecurityGroup, ejecute el siguiente comando:
PS >Get-AWSCmdletName -ApiOperation SecurityGroup -MatchWithRegexCmdletName ServiceOperation ServiceName CmdletNounPrefix ---------- ---------------- ----------- ---------------- Approve-ECCacheSecurityGroupIngress AuthorizeCacheSecurityGroupIngress Amazon ElastiCache EC Get-ECCacheSecurityGroup DescribeCacheSecurityGroups Amazon ElastiCache EC New-ECCacheSecurityGroup CreateCacheSecurityGroup Amazon ElastiCache EC Remove-ECCacheSecurityGroup DeleteCacheSecurityGroup Amazon ElastiCache EC Revoke-ECCacheSecurityGroupIngress RevokeCacheSecurityGroupIngress Amazon ElastiCache EC Add-EC2SecurityGroupToClientVpnTargetNetwrk ApplySecurityGroupsToClientVpnTargetNetwork Amazon Elastic Compute Cloud EC2 Get-EC2SecurityGroup DescribeSecurityGroups Amazon Elastic Compute Cloud EC2 Get-EC2SecurityGroupReference DescribeSecurityGroupReferences Amazon Elastic Compute Cloud EC2 Get-EC2StaleSecurityGroup DescribeStaleSecurityGroups Amazon Elastic Compute Cloud EC2 Grant-EC2SecurityGroupEgress AuthorizeSecurityGroupEgress Amazon Elastic Compute Cloud EC2 Grant-EC2SecurityGroupIngress AuthorizeSecurityGroupIngress Amazon Elastic Compute Cloud EC2 New-EC2SecurityGroup CreateSecurityGroup Amazon Elastic Compute Cloud EC2 Remove-EC2SecurityGroup DeleteSecurityGroup Amazon Elastic Compute Cloud EC2 Revoke-EC2SecurityGroupEgress RevokeSecurityGroupEgress Amazon Elastic Compute Cloud EC2 Revoke-EC2SecurityGroupIngress RevokeSecurityGroupIngress Amazon Elastic Compute Cloud EC2 Update-EC2SecurityGroupRuleEgressDescription UpdateSecurityGroupRuleDescriptionsEgress Amazon Elastic Compute Cloud EC2 Update-EC2SecurityGroupRuleIngressDescription UpdateSecurityGroupRuleDescriptionsIngress Amazon Elastic Compute Cloud EC2 Edit-EFSMountTargetSecurityGroup ModifyMountTargetSecurityGroups Amazon Elastic File System EFS Get-EFSMountTargetSecurityGroup DescribeMountTargetSecurityGroups Amazon Elastic File System EFS Join-ELBSecurityGroupToLoadBalancer ApplySecurityGroupsToLoadBalancer Elastic Load Balancing ELB Set-ELB2SecurityGroup SetSecurityGroups Elastic Load Balancing V2 ELB2 Enable-RDSDBSecurityGroupIngress AuthorizeDBSecurityGroupIngress Amazon Relational Database Service RDS Get-RDSDBSecurityGroup DescribeDBSecurityGroups Amazon Relational Database Service RDS New-RDSDBSecurityGroup CreateDBSecurityGroup Amazon Relational Database Service RDS Remove-RDSDBSecurityGroup DeleteDBSecurityGroup Amazon Relational Database Service RDS Revoke-RDSDBSecurityGroupIngress RevokeDBSecurityGroupIngress Amazon Relational Database Service RDS Approve-RSClusterSecurityGroupIngress AuthorizeClusterSecurityGroupIngress Amazon Redshift RS Get-RSClusterSecurityGroup DescribeClusterSecurityGroups Amazon Redshift RS New-RSClusterSecurityGroup CreateClusterSecurityGroup Amazon Redshift RS Remove-RSClusterSecurityGroup DeleteClusterSecurityGroup Amazon Redshift RS Revoke-RSClusterSecurityGroupIngress RevokeClusterSecurityGroupIngress Amazon Redshift RS
Si conoce el nombre del servicio de AWS que desea usar, pero no la API del servicio de AWS, agregue tanto el parámetro -MatchWithRegex como el parámetro -Service para establecer el ámbito de la búsqueda en un solo servicio. Por ejemplo, para obtener todos los nombres de cmdlet que contienen SecurityGroup solo en el servicio de Amazon EC2, ejecute el siguiente comando:
PS >Get-AWSCmdletName -ApiOperation SecurityGroup -MatchWithRegex -Service EC2CmdletName ServiceOperation ServiceName CmdletNounPrefix ---------- ---------------- ----------- ---------------- Add-EC2SecurityGroupToClientVpnTargetNetwrk ApplySecurityGroupsToClientVpnTargetNetwork Amazon Elastic Compute Cloud EC2 Get-EC2SecurityGroup DescribeSecurityGroups Amazon Elastic Compute Cloud EC2 Get-EC2SecurityGroupReference DescribeSecurityGroupReferences Amazon Elastic Compute Cloud EC2 Get-EC2StaleSecurityGroup DescribeStaleSecurityGroups Amazon Elastic Compute Cloud EC2 Grant-EC2SecurityGroupEgress AuthorizeSecurityGroupEgress Amazon Elastic Compute Cloud EC2 Grant-EC2SecurityGroupIngress AuthorizeSecurityGroupIngress Amazon Elastic Compute Cloud EC2 New-EC2SecurityGroup CreateSecurityGroup Amazon Elastic Compute Cloud EC2 Remove-EC2SecurityGroup DeleteSecurityGroup Amazon Elastic Compute Cloud EC2 Revoke-EC2SecurityGroupEgress RevokeSecurityGroupEgress Amazon Elastic Compute Cloud EC2 Revoke-EC2SecurityGroupIngress RevokeSecurityGroupIngress Amazon Elastic Compute Cloud EC2 Update-EC2SecurityGroupRuleEgressDescription UpdateSecurityGroupRuleDescriptionsEgress Amazon Elastic Compute Cloud EC2 Update-EC2SecurityGroupRuleIngressDescription UpdateSecurityGroupRuleDescriptionsIngress Amazon Elastic Compute Cloud EC2
Si conoce el nombre del comando de AWS Command Line Interface (AWS CLI), puede utilizar el parámetro -AwsCliCommand y el nombre de comando de la AWS CLI deseada para obtener el nombre del cmdlet basado en la misma API. Por ejemplo, para obtener el nombre de cmdlet correspondiente a la llamada al comando authorize-security-group-ingress de la AWS CLI en el servicio de Amazon EC2, ejecute el siguiente comando:
PS >Get-AWSCmdletName -AwsCliCommand "aws ec2 authorize-security-group-ingress"CmdletName ServiceOperation ServiceName CmdletNounPrefix ---------- ---------------- ----------- ---------------- Grant-EC2SecurityGroupIngress AuthorizeSecurityGroupIngress Amazon Elastic Compute Cloud EC2
El cmdlet Get-AWSCmdletName solo necesita una parte del nombre de comando de la AWS CLI para identificar el servicio y la API de AWS.
Para obtener una lista de todos los cmdlets en Tools for PowerShell Core, ejecute el cmdlet Get-Command de PowerShell, como se muestra en el siguiente ejemplo.
PS >Get-Command -Module AWSPowerShell.NetCore
Puede ejecutar el mismo comando con -Module AWSPowerShell para ver los cmdlets en las AWS Tools for Windows PowerShell.
El cmdlet Get-Command genera la lista de cmdlets en orden alfabético. Tenga en cuenta que, de forma predeterminada, la lista se ordena por verbo de PowerShell en lugar de por nombre de PowerShell.
Para ordenar los resultados por servicio en su lugar, ejecute el siguiente comando:
PS >Get-Command -Module AWSPowerShell.NetCore | Sort-Object Noun,Verb
Para filtrar los cmdlets devueltos por el cmdlet Get-Command, pase la salida al cmdlet Select-String de PowerShell. Por ejemplo, para ver el conjunto de cmdlets que funcionan con regiones de AWS, ejecute el siguiente comando:
PS >Get-Command -Module AWSPowerShell.NetCore | Select-String regionClear-DefaultAWSRegion Copy-HSM2BackupToRegion Get-AWSRegion Get-DefaultAWSRegion Get-EC2Region Get-LSRegionList Get-RDSSourceRegion Set-DefaultAWSRegion
También puede encontrar cmdlets para un servicio específico filtrando por el prefijo de servicio de los nombres de cmdlet. Para ver la lista de prefijos de servicio disponibles, ejecute Get-AWSPowerShellVersion -ListServiceVersionInfo. El siguiente ejemplo devuelve cmdlets que admiten el servicio de Amazon CloudWatch Events.
PS >Get-Command -Module AWSPowerShell -Noun CWE*CommandType Name Version Source ----------- ---- ------- ------ Cmdlet Add-CWEResourceTag 3.3.563.1 AWSPowerShell.NetCore Cmdlet Disable-CWEEventSource 3.3.563.1 AWSPowerShell.NetCore Cmdlet Disable-CWERule 3.3.563.1 AWSPowerShell.NetCore Cmdlet Enable-CWEEventSource 3.3.563.1 AWSPowerShell.NetCore Cmdlet Enable-CWERule 3.3.563.1 AWSPowerShell.NetCore Cmdlet Get-CWEEventBus 3.3.563.1 AWSPowerShell.NetCore Cmdlet Get-CWEEventBusList 3.3.563.1 AWSPowerShell.NetCore Cmdlet Get-CWEEventSource 3.3.563.1 AWSPowerShell.NetCore Cmdlet Get-CWEEventSourceList 3.3.563.1 AWSPowerShell.NetCore Cmdlet Get-CWEPartnerEventSource 3.3.563.1 AWSPowerShell.NetCore Cmdlet Get-CWEPartnerEventSourceAccountList 3.3.563.1 AWSPowerShell.NetCore Cmdlet Get-CWEPartnerEventSourceList 3.3.563.1 AWSPowerShell.NetCore Cmdlet Get-CWEResourceTag 3.3.563.1 AWSPowerShell.NetCore Cmdlet Get-CWERule 3.3.563.1 AWSPowerShell.NetCore Cmdlet Get-CWERuleDetail 3.3.563.1 AWSPowerShell.NetCore Cmdlet Get-CWERuleNamesByTarget 3.3.563.1 AWSPowerShell.NetCore Cmdlet Get-CWETargetsByRule 3.3.563.1 AWSPowerShell.NetCore Cmdlet New-CWEEventBus 3.3.563.1 AWSPowerShell.NetCore Cmdlet New-CWEPartnerEventSource 3.3.563.1 AWSPowerShell.NetCore Cmdlet Remove-CWEEventBus 3.3.563.1 AWSPowerShell.NetCore Cmdlet Remove-CWEPartnerEventSource 3.3.563.1 AWSPowerShell.NetCore Cmdlet Remove-CWEPermission 3.3.563.1 AWSPowerShell.NetCore Cmdlet Remove-CWEResourceTag 3.3.563.1 AWSPowerShell.NetCore Cmdlet Remove-CWERule 3.3.563.1 AWSPowerShell.NetCore Cmdlet Remove-CWETarget 3.3.563.1 AWSPowerShell.NetCore Cmdlet Test-CWEEventPattern 3.3.563.1 AWSPowerShell.NetCore Cmdlet Write-CWEEvent 3.3.563.1 AWSPowerShell.NetCore Cmdlet Write-CWEPartnerEvent 3.3.563.1 AWSPowerShell.NetCore Cmdlet Write-CWEPermission 3.3.563.1 AWSPowerShell.NetCore Cmdlet Write-CWERule 3.3.563.1 AWSPowerShell.NetCore Cmdlet Write-CWETarget 3.3.563.1 AWSPowerShell.NetCore
Nomenclatura y alias de cmdlets
Los cmdlets en las AWS Tools for PowerShell para cada servicio se basan en los métodos que proporciona el AWS SDK para el servicio. No obstante, debido a las convenciones obligatorias de nomenclatura de PowerShell, el nombre de un cmdlet puede ser diferente del nombre de la llamada a la API o del método en el que se basa. Por ejemplo, el cmdlet Get-EC2Instance se basa en el método DescribeInstances de Amazon EC2.
En algunos casos, el nombre de cmdlet puede ser similar a un nombre de método, pero realizar una función diferente. Por ejemplo, el método GetObject de Amazon S3 recupera un objeto de Amazon S3. Sin embargo, el cmdlet Get-S3Object devuelve información sobre un objeto de Amazon S3 en lugar del propio objeto.
PS >Get-S3Object -BucketName text-content -Key aws-tech-docsETag : "df000002a0fe0000f3c000004EXAMPLE" BucketName : aws-tech-docs Key : javascript/frameset.js LastModified : 6/13/2011 1:24:18 PM Owner : Amazon.S3.Model.Owner Size : 512 StorageClass : STANDARD
Para obtener un objeto de S3 con las AWS Tools for PowerShell, ejecute el cmdlet Read-S3Object:
PS >Read-S3Object -BucketName text-content -Key text-object.txt -file c:\tmp\text-object-download.textMode LastWriteTime Length Name ---- ------------- ------ ---- -a--- 11/5/2012 7:29 PM 20622 text-object-download.text
nota
La ayuda de un cmdlet de AWS proporciona el nombre de la API de AWS SDK sobre el que se basa el cmdlet.
Para obtener más información acerca de los verbos de PowerShell estándares y sus significados, consulte Verbos aprobados para comandos de PowerShell
Todos los cmdlets de AWS que utilizan el verbo Remove, y el cmdlet Stop-EC2Instance cuando se agrega el parámetro -Terminate, solicitan confirmación antes de continuar. Para eludir la confirmación, añada el parámetro -Force a su comando.
importante
Los cmdlets de AWS no admiten el modificador -WhatIf.
Alias
La instalación de AWS Tools for PowerShell instala un archivo de alias que contiene alias para muchos de los cmdlets de AWS. Tal vez estos alias le resulten más intuitivos que los nombres de cmdlet. Por ejemplo, los nombres de los servicios y los nombres de los métodos de AWS SDK sustituyen a los verbos y los nombres de PowerShell en algunos alias. Un ejemplo es el alias EC2-DescribeInstances.
Otros alias usan verbos que, aunque no siguen las convenciones de PowerShell estándar, pueden describir mejor la operación real. Por ejemplo, el archivo de alias asocia el alias Get-S3Content al cmdlet Read-S3Object.
PS >Set-Alias -Name Get-S3Content -Value Read-S3Object
El archivo de alias se encuentra en el directorio de instalación de las AWS Tools for PowerShell. Para cargar los alias en su entorno, use la notación dot-source en el archivo. A continuación se muestra un ejemplo basado en Windows.
PS >. "C:\Program Files (x86)\AWS Tools\PowerShell\AWSPowershell\AWSAliases.ps1"
Para un shell de Linux o macOS, podría ser así:
. ~/.local/share/powershell/Modules/AWSPowerShell.NetCore/3.3.563.1/AWSAliases.ps1
Para mostrar todos los alias de las AWS Tools for PowerShell, ejecute el siguiente comando. Este comando utiliza el alias ? para el cmdlet de PowerShell Where-Object y la propiedad Source para filtrar solo los alias que provengan solo del módulo AWSPowerShell.NetCore.
PS >Get-Alias | ? Source -like "AWSPowerShell.NetCore"CommandType Name Version Source ----------- ---- ------- ------ Alias Add-ASInstances 3.3.343.0 AWSPowerShell Alias Add-CTTag 3.3.343.0 AWSPowerShell Alias Add-DPTags 3.3.343.0 AWSPowerShell Alias Add-DSIpRoutes 3.3.343.0 AWSPowerShell Alias Add-ELBTags 3.3.343.0 AWSPowerShell Alias Add-EMRTag 3.3.343.0 AWSPowerShell Alias Add-ESTag 3.3.343.0 AWSPowerShell Alias Add-MLTag 3.3.343.0 AWSPowerShell Alias Clear-AWSCredentials 3.3.343.0 AWSPowerShell Alias Clear-AWSDefaults 3.3.343.0 AWSPowerShell Alias Dismount-ASInstances 3.3.343.0 AWSPowerShell Alias Edit-EC2Hosts 3.3.343.0 AWSPowerShell Alias Edit-RSClusterIamRoles 3.3.343.0 AWSPowerShell Alias Enable-ORGAllFeatures 3.3.343.0 AWSPowerShell Alias Find-CTEvents 3.3.343.0 AWSPowerShell Alias Get-ASACases 3.3.343.0 AWSPowerShell Alias Get-ASAccountLimits 3.3.343.0 AWSPowerShell Alias Get-ASACommunications 3.3.343.0 AWSPowerShell Alias Get-ASAServices 3.3.343.0 AWSPowerShell Alias Get-ASASeverityLevels 3.3.343.0 AWSPowerShell Alias Get-ASATrustedAdvisorCheckRefreshStatuses 3.3.343.0 AWSPowerShell Alias Get-ASATrustedAdvisorChecks 3.3.343.0 AWSPowerShell Alias Get-ASATrustedAdvisorCheckSummaries 3.3.343.0 AWSPowerShell Alias Get-ASLifecycleHooks 3.3.343.0 AWSPowerShell Alias Get-ASLifecycleHookTypes 3.3.343.0 AWSPowerShell Alias Get-AWSCredentials 3.3.343.0 AWSPowerShell Alias Get-CDApplications 3.3.343.0 AWSPowerShell Alias Get-CDDeployments 3.3.343.0 AWSPowerShell Alias Get-CFCloudFrontOriginAccessIdentities 3.3.343.0 AWSPowerShell Alias Get-CFDistributions 3.3.343.0 AWSPowerShell Alias Get-CFGConfigRules 3.3.343.0 AWSPowerShell Alias Get-CFGConfigurationRecorders 3.3.343.0 AWSPowerShell Alias Get-CFGDeliveryChannels 3.3.343.0 AWSPowerShell Alias Get-CFInvalidations 3.3.343.0 AWSPowerShell Alias Get-CFNAccountLimits 3.3.343.0 AWSPowerShell Alias Get-CFNStackEvents 3.3.343.0 AWSPowerShell ...
Para añadir su propio alias a este archivo, es posible que tenga que aumentar el valor de la variable de la preferencia $MaximumAliasCount de PowerShell
PS >$MaximumAliasCount = 32768
Para verificar que el cambio se ha realizado correctamente, escriba el nombre de la variable para que muestre su valor actual.
PS >$MaximumAliasCount32768
