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.
AWS Service Catalog Descripción general de la API
Ventajas del uso de la API de Service Catalog
La AWS Service Catalog API proporciona un control programático sobre todas las acciones del usuario final como alternativa al uso de. Consola de administración de AWS Al utilizar la API, puede hacer lo siguiente:
-
Escribe tus propias interfaces y aplicaciones personalizadas
-
Obtenga un control detallado de las operaciones de aprovisionamiento de productos para los usuarios finales
-
Integre el aprovisionamiento de recursos en sus procesos de organización
-
Acceda a una ubicación central que aloje sus aplicaciones con sus recursos
Acceda al catálogo de servicios
Para crear aplicaciones mediante API de idiomas específicos, utilice las bibliotecas, el código de muestra, los tutoriales y otros recursos para desarrolladores de software. Estas bibliotecas proporcionan funciones básicas que automatizan tareas como la firma criptográfica de las solicitudes o el tratamiento de las respuestas de error, facilitándole así el comienzo. Para empezar, abre las Herramientas de Amazon Web Services
Si prefiere utilizar una interfaz de línea de comandos, dispone de las siguientes opciones:
- AWS Interfaz de línea de comandos (CLI)
-
Para empezar, consulte la AWS Command Line Interface Guía del usuario de . Para obtener más información sobre los comandos de Service Catalog, consulte servicecatalog en la AWS CLI Referencia de comandos.
- AWS Herramientas para Windows PowerShell
-
Para empezar, consulte la Herramientas de AWS para PowerShell Guía del usuario de . Para obtener más información acerca de los cmdlets de Service Catalog, abra la referencia de Herramientas de AWS para PowerShell cmdlets y amplíe. AWS Service Catalog
La AWS Service Catalog API se puede dividir de forma lógica en las siguientes categorías.
Temas
Descubrimiento de productos
Utilice estas operaciones para descubrir u obtener información sobre los productos y sus requisitos de lanzamiento. Estas operaciones no crean ni modifican recursos.
- SearchProducts
-
Muestra todos los productos a los que tiene acceso la persona que llama.
- DescribeProduct
-
Obtenga información detallada sobre un producto.
- DescribeProductView
-
Funcionalmente idéntico a
DescribeProduct, excepto que toma el ID de una vista de producto en lugar del ID de un producto. - ListLaunchPaths
-
Muestra todas las formas en que el usuario tiene acceso a un producto específico, denominadas rutas al producto. El usuario debe seleccionar una ruta para aprovisionar el producto.
- DescribeProvisioningParameters
-
Obtiene los parámetros necesarios para aprovisionar un producto específico y proporciona metadatos adicionales sobre lo que ocurrirá cuando se aprovisione el producto.
Cada uno de ellos
ProvisioningArtifactParameteres algo que el usuario debe especificar para poder aprovisionar correctamente el producto (por ejemplo, el tamaño de una instancia EC2). LosConstraintSummaryobjetos contienen la lista de valores permitidos y metadatos adicionales sobre losProvisioningArtifactParameterobjetos.
Solicitudes de aprovisionamiento
Utilice estas operaciones para solicitar, actualizar o finalizar el aprovisionamiento de un producto.
- ProvisionProduct
-
Solicita el aprovisionamiento de un producto. Aprovisionar un producto es lanzar los recursos necesarios para ponerlo en línea para su uso real. Por ejemplo, aprovisionar un producto respaldado por una CloudFormation plantilla significa lanzar una CloudFormation pila y todos sus recursos subyacentes.
- UpdateProvisionedProduct
-
Actualiza la configuración de un producto aprovisionado. Por ejemplo, un producto respaldado por CloudFormation actualiza su CloudFormation pila subyacente. El solicitante debe tener permisos de acceso suficientes para lo especificado ProvisionedProduct.
- TerminateProvisionedProduct
-
Solicita la rescisión de un producto aprovisionado. Por ejemplo, en el caso de un producto respaldado por CloudFormation, esto elimina la pila subyacente CloudFormation . El solicitante debe tener suficientes permisos de acceso al producto aprovisionado especificado.
Productos aprovisionados
Utilice estas operaciones para obtener información sobre los productos aprovisionados. Estas operaciones no crean ni modifican recursos.
- ListRecordHistory
-
Muestra todas las solicitudes realizadas, incluso las de los productos aprovisionados cancelados.
- DescribeRecord
-
Obtiene información sobre una solicitud. Utilice esta operación después de la operación de solicitud para obtener la
RecordDetailinformación actual. - SearchProvisionedProducts
-
Obtiene información sobre los productos aprovisionados que cumplen los criterios especificados.
- ScanProvisionedProducts
-
Muestra los productos aprovisionados que no están terminados.
- DescribeProvisionedProduct
-
Obtiene información sobre un producto aprovisionado.
- ImportAsProvisionedProduct
-
Solicita la importación de un recurso como un producto aprovisionado de Service Catalog que está asociado a un producto de Service Catalog y a un artefacto de aprovisionamiento. Una vez importadas, todas las acciones de gobierno de Service Catalog compatibles se admiten en el producto aprovisionado.
- UpdateProvisionedProductProperties
-
Solicita actualizaciones de las propiedades del producto aprovisionado especificado.
Planes de productos aprovisionados
Utilice estas operaciones para gestionar los planes de productos aprovisionados. Un plan incluye la lista de recursos que se pueden crear o modificar al ejecutar el plan.
- CreateProvisionedProductPlan
Crea un plan.
- DescribeProvisionedProductPlan
Obtiene información sobre los cambios en los recursos de un plan.
- ExecuteProvisionedProductPlan
Aprovisiona o modifica un producto en función de un plan.
- ListProvisionedProductPlans
Muestra los planes de un producto aprovisionado.
- DeleteProvisionedProductPlan
Elimina un plan.
Carteras
Los administradores del catálogo utilizan estas operaciones para proporcionar todas las operaciones necesarias para la administración de la cartera.
- CreatePortfolio
Crea una cartera.
- DeletePortfolio
Elimina una cartera.
- DescribePortfolio
Obtiene información detallada sobre una cartera.
- DescribePortfolioShares
Devuelve un resumen de cada una de las acciones de la cartera que se crearon para la cartera especificada.
- ListPortfolios
Muestra todas las carteras del catálogo.
- ListPortfoliosForProduct
Muestra todas las carteras a las que está asociado un producto.
- UpdatePortfolio
Actualiza una cartera.
- UpdatePortfolioShare
Actualiza una cuota de cartera.
- CreatePortfolioShare
Comparte una cartera con una AWS cuenta.
- DeletePortfolioShare
Deja de compartir una cartera.
- AcceptPortfolioShare
Acepta una oferta para compartir una cartera.
- RejectPortfolioShare
Rechaza una oferta de compartir una cartera.
- ListAcceptedPortfolioShares
Muestra los detalles de todas las carteras que esta cuenta ha aceptado compartir.
- ListPortfolioAccess
Muestra los ID de cuenta que tienen acceso a una cartera.
Asociación principal
Los administradores del catálogo utilizan estas operaciones para realizar todas las operaciones necesarias para la asociación principal.
- AssociatePrincipalWithPortfolio
Asocia un ARN principal a una cartera.
- DisassociatePrincipalFromPortfolio
Disocia un ARN principal de una cartera.
- ListPrincipalsForPortfolio
Muestra todos los ARN principales asociados a una cartera.
Productos
Los administradores del catálogo utilizan estas operaciones para proporcionar todas las operaciones necesarias para la administración del producto.
- SearchProductsAsAdmin
Obtiene información resumida y de estado de los productos.
- DescribeProductAsAdmin
Obtiene información sobre un producto.
- CreateProduct
Crea un producto.
- CopyProduct
Copia un producto.
- DescribeCopyProductStatus
Obtiene el estado de una operación de copia de un producto.
- UpdateProduct
Actualiza un producto.
- DeleteProduct
Elimina un producto.
- AssociateProductWithPortfolio
Asocia un producto a una cartera.
- DisassociateProductFromPortfolio
Disocia un producto de una cartera.
Aprovisionamiento de artefactos
Los administradores del catálogo utilizan estas operaciones para administrar los artefactos de aprovisionamiento (también conocidos como versiones de productos).
- DescribeProvisioningArtifact
Obtiene información sobre un artefacto de aprovisionamiento.
- CreateProvisioningArtifact
Crea un artefacto de aprovisionamiento para un producto.
- DeleteProvisioningArtifact
Elimina un artefacto de aprovisionamiento.
- ListProvisioningArtifacts
Muestra todos los artefactos de aprovisionamiento asociados a un producto.
- UpdateProvisioningArtifact
Actualiza un artefacto de aprovisionamiento.
Restricciones
El administrador del catálogo utiliza estas operaciones para gestionar las restricciones.
- CreateConstraint
Crea una restricción.
- DeleteConstraint
Elimina una restricción.
- DescribeConstraint
Obtiene información sobre una restricción.
- UpdateConstraint
Actualiza una restricción.
- ListConstraintsForPortfolio
Obtiene información sobre las restricciones de una cartera y un producto.
Acciones de servicio
Los administradores del catálogo utilizan estas operaciones para gestionar las acciones de servicio.
- AssociateServiceActionWithProvisioningArtifact
Asocia una acción de autoservicio a un artefacto de aprovisionamiento.
- CreateServiceAction
Crea una acción de autoservicio.
- DeleteServiceAction
Elimina una acción de autoservicio.
- DescribeServiceAction
Describe una acción de autoservicio.
- DescribeServiceActionExecutionParameters
Busca los parámetros predeterminados de una acción de autoservicio específica en un producto aprovisionado específico y devuelve un mapa de los resultados al usuario.
- ExecuteProvisionedProductServiceAction
Ejecuta una acción de autoservicio contra un producto aprovisionado.
- UpdateServiceAction
Actualiza una acción de autoservicio.
TagOptions
Los administradores del catálogo utilizan estas operaciones para administrar. TagOptions
- CreateTagOption
Crea un TagOption.
- ListTagOptions
Enumera tus TagOptions.
- DescribeTagOption
Describe un TagOption.
- UpdateTagOption
Actualiza un TagOption.
- AssociateTagOptionWithResource
Asocia a TagOption a un recurso.
- DisassociateTagOptionFromResource
Disocia a TagOption de un recurso.
- ListResourcesForTagOption
Muestra los recursos de un TagOption.
- DeleteTagOption
Elimina un TagOption.
AppRegistry
Sirve como repositorio para sus aplicaciones, sus recursos y los metadatos de las aplicaciones que utiliza en su empresa.
- AssociateAttributeGroup
Asocia un grupo de atributos a una aplicación para aumentar los metadatos de la aplicación con los atributos del grupo.
- AssociateResource
Asocia un recurso a una aplicación.
- CreateApplication
Crea una nueva aplicación que es el nodo de nivel superior de una jerarquía de abstracciones de recursos de nube relacionados.
- CreateAttributeGroup
Crea un nuevo grupo de atributos como contenedor para atributos definidos por el usuario.
- DeleteApplication
Elimina una aplicación que se especifica por su nombre o ID de aplicación.
- DeleteAttributeGroup
Elimina un grupo de atributos, especificado por su ID o nombre del grupo de atributos.
- DisassociateAttributeGroup
Disocia un grupo de atributos de una aplicación para eliminar los atributos adicionales contenidos en el grupo de atributos de los metadatos de la aplicación.
- DisassociateResource
Disocia un recurso de la aplicación.
- GetApplication
Recupera información de metadatos sobre una de sus aplicaciones.
- GetAssociatedResource
Obtiene el recurso asociado a la aplicación.
- GetAttributeGroup
Recupera un grupo de atributos, ya sea por su nombre o por su identificador.
- ListApplications
Muestra todos los grupos de atributos que están asociados a la aplicación especificada.
- ListAssociatedAttributeGroups
Muestra todos los grupos de atributos que están asociados a la aplicación especificada.
- ListAssociatedResources
Muestra todos los recursos asociados a la aplicación especificada.
- ListAttributeGroups
Muestra todos los grupos de atributos a los que tiene acceso.
- ListAttributeGroupsForApplication
Muestra los detalles de todos los grupos de atributos asociados a una aplicación específica.
- ListTagsForResource
Muestra todas las etiquetas del recurso.
- TagResource
Asigna una o más etiquetas (pares clave-valor) al recurso especificado.
- SyncResource
Sincroniza el recurso con lo que está registrado actualmente. AppRegistry
- UntagResource
Elimina etiquetas de un recurso.
- UpdateApplication
Actualiza una aplicación existente con nuevos atributos.
- UpdateAttributeGroup
Actualiza un grupo de atributos existente con nuevos detalles.
Ejemplo de flujo de trabajo
En este escenario, el administrador crea recursos utilizando los productos disponibles AWS Service Catalog y un usuario final los encuentra y los aprovisiona. Este es un ejemplo de flujo de trabajo; no es la única forma de utilizar la AWS Service Catalog API.
Tareas de administrador
Cree carteras, vistas de productos, productos, versiones de productos y restricciones.
Asigne usuarios de IAM a los productos, lo que les da acceso.
Tareas del usuario final
-
El usuario llama SearchProductssin argumentos. Esto devuelve la lista de productos a los que tiene acceso el usuario, así como un «SearchDomain» que se puede utilizar para analizar los resultados.
-
El usuario sigue llamando SearchProductscon filtros de búsqueda adicionales hasta encontrar el producto deseado.
-
El usuario llama DescribeProductViewpara buscar la lista de dispositivos de aprovisionamiento (también conocidos como versiones) de este producto. Esto determina lo que realmente aprovisiona el usuario.
-
El usuario llama ListLaunchPathspara buscar la lista de rutas de este producto, junto con las restricciones de cada ruta. Esto determina qué conjunto de restricciones se aplica al producto aprovisionado.
-
Tras elegir un artefacto de aprovisionamiento y una ruta, el usuario llama. DescribeProvisioningParameters Esto devuelve la lista de parámetros que el usuario debe proporcionar antes de aprovisionar un producto mediante el artefacto y la ruta de aprovisionamiento, junto con las instrucciones de uso adicionales que el administrador haya decidido proporcionar.
-
El usuario llama y especifica el producto ProvisionProduct, aprovisiona el artefacto, la ruta y los parámetros de entrada. Los parámetros de entrada son una lista de pares clave-valor, donde las claves se obtienen utilizando DescribeProvisioningParametersy los valores los proporciona el usuario (por ejemplo,).
{ParameterKey:"dbpassword", ParameterValue:"mycoolpassword"}Esto inicia un flujo de trabajo para crear los recursos especificados. AWS También crea un detalle de registro que rastrea la solicitud de aprovisionamiento y un objeto de producto aprovisionado que representa los recursos subyacentes AWS . -
El usuario sondea DescribeRecordpara ver cuándo el estado de los detalles del registro cambia de
IN_PROGRESSestado a estado completo (SUCCEEDEDoERRORcompleto). -
Cuando el detalle del registro de la solicitud está completado, el usuario DescribeRecordvuelve a llamar. Los resultados identifican los recursos creados.
-
El usuario llama UpdateProvisionedProductpara actualizar los recursos subyacentes existentes. En función de las actualizaciones específicas solicitadas, esta operación puede actualizarse sin interrupción, con alguna interrupción o sustituir por completo el producto aprovisionado.
-
Por último, el usuario llama TerminateProvisionedProductpara cancelar el producto aprovisionado.
