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.
CreateProfile
Crea el perfil local o de socio que se utilizará para las transferencias de AS2.
Sintaxis de la solicitud
{
"As2Id": "string
",
"CertificateIds": [ "string
" ],
"ProfileType": "string
",
"Tags": [
{
"Key": "string
",
"Value": "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.
- As2Id
-
El
As2Id
es el nombre AS2, tal como se define en RFC 4130. Para las transferencias entrantes, este es el encabezado AS2-From
de los mensajes AS2 enviados por el socio. Para los conectores de salida, este es el encabezadoAS2-To
de los mensajes AS2 enviados al socio mediante la operaciónStartFileTransfer
de la API. Este ID no puede incluir espacios.Tipo: string
Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 128.
Patrón:
[\p{Print}\s]*
Obligatorio: sí
- CertificateIds
-
Una matriz de identificadores de los certificados importados. Este identificador se utiliza para trabajar con perfiles y perfiles de socios.
Tipo: matriz de cadenas
Limitaciones de longitud: longitud fija de 22.
Patrón:
cert-([0-9a-f]{17})
Obligatorio: no
- ProfileType
-
Determina el tipo de perfil que se va a crear:
-
Especifique
LOCAL
para crear un perfil local. Un perfil local representa la organización o entidad del servidor de Transfer Family habilitado para AS2. -
Especifique
PARTNER
para crear un perfil de socio. Un perfil de socio representa una organización remota, externa a Transfer Family.
Tipo: cadena
Valores válidos:
LOCAL | PARTNER
Obligatorio: sí
-
- Tags
-
Pares clave-valor que se pueden utilizar para agrupar y buscar perfiles AS2.
Tipo: Matriz de Tag objetos
Miembros de la matriz: número mínimo de 1 artículo. Número máximo de 50 artículos.
Obligatorio: no
Sintaxis de la respuesta
{
"ProfileId": "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.
- ProfileId
-
El identificador único del perfil de AS2, que se devuelve después de que la llamada a la API se realiza correctamente.
Tipo: cadena
Limitaciones de longitud: longitud fija de 19.
Patrón:
p-([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
- ThrottlingException
-
La solicitud fue denegada debido a una limitación de la solicitud.
Código de estado HTTP: 400
Ejemplos
Ejemplo
En el siguiente ejemplo, se crea un perfil y se devuelve el identificador del perfil.
Los identificadores del certificado se crean cuando ejecuta import-certificate
, uno para el certificado de firma y otro para el certificado de cifrado.
aws transfer create-profile --as2-id MYCORP --certificate-ids c-abcdefg123456hijk c-987654aaaa321bbbb
Respuesta de ejemplo
La llamada a la API devuelve el ID del perfil para el perfil nuevo.
{ "ProfileId": "p-11112222333344444" }
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: