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.
DescribeAccess
Describe el acceso que se asigna al servidor específico habilitado para el protocolo de transferencia de archivos, identificado por su propiedad ServerId y su ExternalId.
La respuesta de esta llamada devuelve las propiedades del acceso asociado al valor ServerId especificado.
Sintaxis de la solicitud
{
"ExternalId": "string",
"ServerId": "string"
}Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.
La solicitud acepta los siguientes datos en formato JSON.
- ExternalId
-
Un identificador único que se requiere para identificar grupos específicos dentro de su directorio. Los usuarios del grupo que asocie tienen acceso a sus recursos de Amazon S3 o Amazon EFS a través de los protocolos habilitados que utilizan AWS Transfer Family. Si conoce el nombre del grupo, puede ver los valores del SID ejecutando el siguiente comando en Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSidEn ese comando, YourGroupNamesustitúyalo por el nombre del grupo de Active Directory.
La expresión regular utilizada para validar este parámetro es una cadena de caracteres compuesta de caracteres alfanuméricos en mayúscula y minúscula, sin espacios. También puede incluir guiones bajos y cualquiera de los siguientes caracteres: =,.@:/-
Tipo: string
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.
Patrón:
S-1-[\d-]+Obligatorio: sí
- ServerId
-
Identificador único asignado por el sistema para un servidor que tiene asignado este acceso.
Tipo: cadena
Limitaciones de longitud: longitud fija de 19.
Patrón:
s-([0-9a-f]{17})Obligatorio: sí
Sintaxis de la respuesta
{
"Access": {
"ExternalId": "string",
"HomeDirectory": "string",
"HomeDirectoryMappings": [
{
"Entry": "string",
"Target": "string",
"Type": "string"
}
],
"HomeDirectoryType": "string",
"Policy": "string",
"PosixProfile": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"Role": "string"
},
"ServerId": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- Access
-
El identificador externo del servidor al que está conectado el acceso.
Tipo: objeto DescribedAccess
- ServerId
-
Identificador único asignado por el sistema para un servidor que tiene asignado este acceso.
Tipo: cadena
Limitaciones de longitud: longitud fija de 19.
Patrón:
s-([0-9a-f]{17})
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- InternalServiceError
-
Esta excepción se produce cuando se produce un error en el AWS Transfer Family servicio.
Código de estado HTTP: 500
- InvalidRequestException
-
Esta excepción se produce cuando el cliente envía una solicitud con un formato incorrecto.
Código de estado HTTP: 400
- ResourceNotFoundException
-
Esta excepción se produce cuando el servicio AWS Transfer Family no encuentra un recurso.
Código de estado HTTP: 400
- ServiceUnavailableException
-
La solicitud ha fallado porque el servicio AWS Transfer Family no está disponible.
Código de estado HTTP: 500
Véase también
Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente:
